diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-26 08:13:52 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-26 08:21:46 +0100 |
| commit | fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64 (patch) | |
| tree | 8b7d53b172d70fd9f78f400515b73e1d2c4f8e1e | |
| parent | spec/a53: Set conditionally failing test state (diff) | |
| download | rtems-fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64.tar.bz2 | |
bsp/stm32h7: Add and use BSP Doxygen group
Update #3910.
216 files changed, 3517 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal.c index 8fc0f84c93..89205d78c2 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal.c @@ -40,6 +40,7 @@ */
/** @defgroup HAL HAL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL module driver.
* @{
*/
@@ -66,6 +67,7 @@ /* Exported variables --------------------------------------------------------*/
/** @defgroup HAL_Exported_Variables HAL Exported Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#ifndef __rtems__
@@ -81,10 +83,12 @@ HAL_TickFreqTypeDef uwTickFreq = HAL_TICK_FREQ_DEFAULT; /* 1KHz */ /* Private functions ---------------------------------------------------------*/
/** @defgroup HAL_Private_Functions HAL Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HAL_Group1 Initialization and de-initialization Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions
*
@verbatim
@@ -301,6 +305,7 @@ __weak HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority) */
/** @defgroup HAL_Group2 HAL Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL Control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc.c index cce8bf9baa..2f2011bde5 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc.c @@ -309,6 +309,7 @@ */
/** @defgroup ADC ADC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC HAL module driver
* @{
*/
@@ -319,6 +320,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup ADC_Private_Constants ADC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_CFGR_FIELDS_1 ((uint32_t)(ADC_CFGR_RES |\
@@ -358,10 +360,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup ADC_Exported_Functions ADC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC Initialization and Configuration functions
*
@verbatim
@@ -1213,6 +1217,7 @@ HAL_StatusTypeDef HAL_ADC_UnRegisterCallback(ADC_HandleTypeDef *hadc, HAL_ADC_Ca */
/** @defgroup ADC_Exported_Functions_Group2 ADC Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC IO operation functions
*
@verbatim
@@ -2610,6 +2615,7 @@ __weak void HAL_ADC_ErrorCallback(ADC_HandleTypeDef *hadc) */
/** @defgroup ADC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -3135,6 +3141,7 @@ HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig(ADC_HandleTypeDef *hadc, ADC_AnalogWDG */
/** @defgroup ADC_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC Peripheral State functions
*
@verbatim
@@ -3192,6 +3199,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc) */
/** @defgroup ADC_Private_Functions ADC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc_ex.c index 8aa0815044..64b5c4082d 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_adc_ex.c @@ -47,6 +47,7 @@ */
/** @defgroup ADCEx ADCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC Extended HAL module driver
* @{
*/
@@ -57,6 +58,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup ADCEx_Private_Constants ADC Extended Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -87,10 +89,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Functions ADC Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADCEx_Exported_Functions_Group1 Extended Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended IO operation functions
*
@verbatim
@@ -1719,6 +1723,7 @@ HAL_StatusTypeDef HAL_ADCEx_RegularMultiModeStop_DMA(ADC_HandleTypeDef *hadc) */
/** @defgroup ADCEx_Exported_Functions_Group2 ADC Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ADC Extended Peripheral Control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cec.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cec.c index 1b87bac84e..8ae1bfd6b6 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cec.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cec.c @@ -117,6 +117,7 @@ */
/** @defgroup CEC CEC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL CEC module driver
* @{
*/
@@ -126,6 +127,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup CEC_Private_Constants CEC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -136,6 +138,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup CEC_Private_Functions CEC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -145,10 +148,12 @@ /* Exported functions ---------------------------------------------------------*/
/** @defgroup CEC_Exported_Functions CEC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CEC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -649,6 +654,7 @@ HAL_StatusTypeDef HAL_CEC_UnRegisterRxCpltCallback(CEC_HandleTypeDef *hcec) */
/** @defgroup CEC_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CEC Transmit/Receive functions
*
@verbatim
@@ -942,6 +948,7 @@ __weak void HAL_CEC_ErrorCallback(CEC_HandleTypeDef *hcec) */
/** @defgroup CEC_Exported_Functions_Group3 Peripheral Control function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CEC control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_comp.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_comp.c index 8033926129..8c3186b5f1 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_comp.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_comp.c @@ -201,6 +201,7 @@ */
/** @defgroup COMP COMP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief COMP HAL module driver
* @{
*/
@@ -237,10 +238,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup COMP_Exported_Functions COMP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions.
*
@verbatim
@@ -728,6 +731,7 @@ HAL_StatusTypeDef HAL_COMP_UnRegisterCallback(COMP_HandleTypeDef *hcomp, HAL_COM */
/** @defgroup COMP_Exported_Functions_Group2 Start-Stop operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Start-Stop operation functions.
*
@verbatim
@@ -1070,6 +1074,7 @@ void HAL_COMP_IRQHandler(COMP_HandleTypeDef *hcomp) */
/** @defgroup COMP_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Management functions.
*
@verbatim
@@ -1185,6 +1190,7 @@ __weak void HAL_COMP_TriggerCallback(COMP_HandleTypeDef *hcomp) */
/** @defgroup COMP_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cortex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cortex.c index 631f432f7e..57b8b5f612 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cortex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cortex.c @@ -87,6 +87,7 @@ */
/** @defgroup CORTEX CORTEX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CORTEX HAL module driver
* @{
*/
@@ -101,11 +102,13 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup CORTEX_Exported_Functions CORTEX Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CORTEX_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -235,6 +238,7 @@ uint32_t HAL_SYSTICK_Config(uint32_t TicksNumb) */
/** @defgroup CORTEX_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Cortex control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc.c index 5d12b7f610..fc16d0a806 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc.c @@ -50,6 +50,7 @@ */
/** @defgroup CRC CRC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRC HAL module driver.
* @{
*/
@@ -62,6 +63,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup CRC_Private_Functions CRC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t CRC_Handle_8(CRC_HandleTypeDef *hcrc, uint8_t pBuffer[], uint32_t BufferLength);
@@ -73,10 +75,12 @@ static uint32_t CRC_Handle_16(CRC_HandleTypeDef *hcrc, uint16_t pBuffer[], uint3 /* Exported functions --------------------------------------------------------*/
/** @defgroup CRC_Exported_Functions CRC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions.
*
@verbatim
@@ -250,6 +254,7 @@ __weak void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc) */
/** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions.
*
@verbatim
@@ -385,6 +390,7 @@ uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t */
/** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc_ex.c index 2ce184e5d5..2083a0a8e1 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_crc_ex.c @@ -37,6 +37,7 @@ */
/** @defgroup CRCEx CRCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRC Extended HAL module driver
* @{
*/
@@ -51,10 +52,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup CRCEx_Exported_Functions CRC Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRCEx_Exported_Functions_Group1 Extended Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Initialization and Configuration functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp.c index abf8584a2c..612658a2f6 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp.c @@ -273,6 +273,7 @@ #if defined (CRYP)
/** @defgroup CRYP CRYP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYP HAL module driver.
* @{
*/
@@ -371,11 +372,13 @@ static HAL_StatusTypeDef CRYP_TDES_Process(CRYP_HandleTypeDef *hcryp, uint32_t T /* Exported functions ---------------------------------------------------------*/
/** @defgroup CRYP_Exported_Functions CRYP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRYP_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYP Initialization and Configuration functions.
*
@verbatim
@@ -866,6 +869,7 @@ HAL_StatusTypeDef HAL_CRYP_UnRegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRY */
/** @defgroup CRYP_Exported_Functions_Group2 Encrypt Decrypt functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYP processing functions.
*
@verbatim
@@ -1667,6 +1671,7 @@ HAL_StatusTypeDef HAL_CRYP_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint32_t *Inpu */
/** @defgroup CRYP_Exported_Functions_Group3 CRYP IRQ handler management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYP IRQ handler.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp_ex.c index cda921b88a..c46d2f0bd2 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_cryp_ex.c @@ -38,6 +38,7 @@ */
#if defined (CRYP)
/** @defgroup CRYPEx CRYPEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYP Extension HAL module driver.
* @{
*/
@@ -81,6 +82,7 @@ */
/** @defgroup CRYPEx_Exported_Functions_Group1 Extended AES processing functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief CRYPEx Extended processing functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac.c index cf479e2cb9..8d7be1d28e 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac.c @@ -308,6 +308,7 @@ #if defined(DAC1) || defined(DAC2)
/** @defgroup DAC DAC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DAC driver modules
* @{
*/
@@ -330,10 +331,12 @@ /* Exported functions -------------------------------------------------------*/
/** @defgroup DAC_Exported_Functions DAC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DAC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -492,6 +495,7 @@ __weak void HAL_DAC_MspDeInit(DAC_HandleTypeDef *hdac) */
/** @defgroup DAC_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -955,6 +959,7 @@ __weak void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac) */
/** @defgroup DAC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -1169,6 +1174,7 @@ HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef *hdac, DAC_ChannelConf */
/** @defgroup DAC_Exported_Functions_Group4 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State and Errors functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac_ex.c index 75ceee92bf..1109ef03b7 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dac_ex.c @@ -72,6 +72,7 @@ #if defined(DAC1) || defined(DAC2)
/** @defgroup DACEx DACEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DAC Extended HAL module driver
* @{
*/
@@ -84,10 +85,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup DACEx_Exported_Functions DACEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DACEx_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended IO operation functions
*
@verbatim
@@ -747,6 +750,7 @@ uint32_t HAL_DACEx_GetTrimOffset(DAC_HandleTypeDef *hdac, uint32_t Channel) */
/** @defgroup DACEx_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral Control functions
*
@verbatim
@@ -788,6 +792,7 @@ uint32_t HAL_DACEx_DualGetValue(DAC_HandleTypeDef *hdac) /* Private functions ---------------------------------------------------------*/
/** @defgroup DACEx_Private_Functions DACEx private functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended private functions
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dcmi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dcmi.c index ac25ecc549..10f0752f09 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dcmi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dcmi.c @@ -126,6 +126,7 @@ * @{
*/
/** @defgroup DCMI DCMI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DCMI HAL module driver
* @{
*/
@@ -146,10 +147,12 @@ static void DCMI_DMAError(DMA_HandleTypeDef *hdma); /* Exported functions --------------------------------------------------------*/
/** @defgroup DCMI_Exported_Functions DCMI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DCMI_Exported_Functions_Group1 Initialization and Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -330,6 +333,7 @@ __weak void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef *hdcmi) * @}
*/
/** @defgroup DCMI_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -749,6 +753,7 @@ __weak void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi) */
/** @defgroup DCMI_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -889,6 +894,7 @@ HAL_StatusTypeDef HAL_DCMI_ConfigSyncUnmask(DCMI_HandleTypeDef *hdcmi, DCMI_Syn */
/** @defgroup DCMI_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
@@ -1112,6 +1118,7 @@ HAL_StatusTypeDef HAL_DCMI_UnRegisterCallback(DCMI_HandleTypeDef *hdcmi, HAL_DCM */
/* Private functions ---------------------------------------------------------*/
/** @defgroup DCMI_Private_Functions DCMI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm.c index 220e07a960..ede5ec4f79 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm.c @@ -273,6 +273,7 @@ #ifdef HAL_DFSDM_MODULE_ENABLED
/** @defgroup DFSDM DFSDM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DFSDM HAL driver module
* @{
*/
@@ -280,6 +281,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup DFSDM_Private_Define DFSDM Private Define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FLTCR1_MSB_RCH_OFFSET 8
@@ -297,6 +299,7 @@ /* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup DFSDM_Private_Variables DFSDM Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static __IO uint32_t v_dfsdm1ChannelCounter = 0;
@@ -311,6 +314,7 @@ static DFSDM_Channel_HandleTypeDef *a_dfsdm2ChannelHandle[DFSDM2_CHANNEL_NUMBER] /* Private function prototypes -----------------------------------------------*/
/** @defgroup DFSDM_Private_Functions DFSDM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t DFSDM_GetInjChannelsNbr(uint32_t Channels);
@@ -330,10 +334,12 @@ static void DFSDM_DMAError(DMA_HandleTypeDef *hdma); /* Exported functions --------------------------------------------------------*/
/** @defgroup DFSDM_Exported_Functions DFSDM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DFSDM_Exported_Functions_Group1_Channel Channel initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Channel initialization and de-initialization functions
*
@verbatim
@@ -728,6 +734,7 @@ HAL_StatusTypeDef HAL_DFSDM_Channel_UnRegisterCallback(DFSDM_Channel_HandleTypeD */
/** @defgroup DFSDM_Exported_Functions_Group2_Channel Channel operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Channel operation functions
*
@verbatim
@@ -1384,6 +1391,7 @@ HAL_StatusTypeDef HAL_DFSDM_ChannelModifyOffset(DFSDM_Channel_HandleTypeDef *hdf */
/** @defgroup DFSDM_Exported_Functions_Group3_Channel Channel state function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Channel state function
*
@verbatim
@@ -1412,6 +1420,7 @@ HAL_DFSDM_Channel_StateTypeDef HAL_DFSDM_ChannelGetState(DFSDM_Channel_HandleTyp */
/** @defgroup DFSDM_Exported_Functions_Group1_Filter Filter initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Filter initialization and de-initialization functions
*
@verbatim
@@ -1875,6 +1884,7 @@ HAL_StatusTypeDef HAL_DFSDM_Filter_UnRegisterAwdCallback(DFSDM_Filter_HandleType */
/** @defgroup DFSDM_Exported_Functions_Group2_Filter Filter control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Filter control functions
*
@verbatim
@@ -1977,6 +1987,7 @@ HAL_StatusTypeDef HAL_DFSDM_FilterConfigInjChannel(DFSDM_Filter_HandleTypeDef *h */
/** @defgroup DFSDM_Exported_Functions_Group3_Filter Filter operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Filter operation functions
*
@verbatim
@@ -3395,6 +3406,7 @@ __weak void HAL_DFSDM_FilterErrorCallback(DFSDM_Filter_HandleTypeDef *hdfsdm_fil */
/** @defgroup DFSDM_Exported_Functions_Group4_Filter Filter state functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Filter state functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c index e0349b4a47..b11d058fa3 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c @@ -33,6 +33,7 @@ #if defined(DFSDM_CHDLYR_PLSSKP)
/** @defgroup DFSDMEx DFSDMEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DFSDM Extended HAL module driver
* @{
*/
@@ -45,10 +46,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup DFSDMEx_Exported_Functions DFSDM Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DFSDMEx_Exported_Functions_Group1_Channel Extended channel operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DFSDM extended channel operation functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma.c index da7510b142..dcdf8fe7f2 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma.c @@ -100,6 +100,7 @@ */
/** @defgroup DMA DMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma2d.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma2d.c index b6b8d4099d..92666bb92f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma2d.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma2d.c @@ -171,6 +171,7 @@ */
/** @defgroup DMA2D DMA2D
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA2D HAL module driver
* @{
*/
@@ -178,10 +179,12 @@ /* Private types -------------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup DMA2D_Private_Constants DMA2D Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_TimeOut DMA2D Time Out
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_TIMEOUT_ABORT (1000U) /*!< 1s */
@@ -209,10 +212,12 @@ static void DMA2D_SetConfig(DMA2D_HandleTypeDef *hdma2d, uint32_t pdata, uint32_ /* Private functions ---------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup DMA2D_Exported_Functions DMA2D Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -621,6 +626,7 @@ HAL_StatusTypeDef status = HAL_OK; /** @defgroup DMA2D_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -1722,6 +1728,7 @@ __weak void HAL_DMA2D_CLUTLoadingCpltCallback(DMA2D_HandleTypeDef *hdma2d) */
/** @defgroup DMA2D_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -2022,6 +2029,7 @@ HAL_StatusTypeDef HAL_DMA2D_ConfigDeadTime(DMA2D_HandleTypeDef *hdma2d, uint8_t /** @defgroup DMA2D_Exported_Functions_Group4 Peripheral State and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
@@ -2069,6 +2077,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d) /** @defgroup DMA2D_Private_Functions DMA2D Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma_ex.c index 294ce8cedd..b534adc5a5 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dma_ex.c @@ -56,6 +56,7 @@ */
/** @defgroup DMAEx DMAEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Extended HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dsi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dsi.c index badc634835..9bb194580e 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dsi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dsi.c @@ -251,6 +251,7 @@ static HAL_StatusTypeDef DSI_ShortWrite(DSI_HandleTypeDef *hdsi, */
/** @defgroup DSI_Group1 Initialization and Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -762,6 +763,7 @@ HAL_StatusTypeDef HAL_DSI_UnRegisterCallback(DSI_HandleTypeDef *hdsi, HAL_DSI_Ca */
/** @defgroup DSI_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -945,6 +947,7 @@ __weak void HAL_DSI_ErrorCallback(DSI_HandleTypeDef *hdsi) */
/** @defgroup DSI_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -2644,6 +2647,7 @@ HAL_StatusTypeDef HAL_DSI_SetContentionDetectionOff(DSI_HandleTypeDef *hdsi, Fun */
/** @defgroup DSI_Group4 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State and Errors functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dts.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dts.c index a6227c7c21..0c0282f9b4 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dts.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dts.c @@ -52,6 +52,7 @@ #if defined(DTS)
/** @defgroup DTS DTS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DTS HAL module driver
* @{
*/
@@ -85,10 +86,12 @@ static void DTS_ResetCallback(DTS_HandleTypeDef *hdts); /* Exported functions --------------------------------------------------------*/
/** @defgroup DTS_Exported_Functions DTS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DTS_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions.
*
@verbatim
@@ -278,6 +281,7 @@ __weak void HAL_DTS_MspDeInit(DTS_HandleTypeDef *hdts) */
/** @defgroup DTS_Exported_Functions_Group2 Start-Stop operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Start-Stop operation functions.
*
@verbatim
@@ -744,6 +748,7 @@ __weak void HAL_DTS_AsyncHighCallback(DTS_HandleTypeDef *hdts) */
/** @defgroup DTS_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
@@ -784,6 +789,7 @@ HAL_DTS_StateTypeDef HAL_DTS_GetState(DTS_HandleTypeDef *hdts) /* Private functions ---------------------------------------------------------*/
/** @defgroup DTS_Private_Functions DTS Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (USE_HAL_DTS_REGISTER_CALLBACKS == 1)
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth.c index a1b1fa0ff2..4f2634df5b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth.c @@ -154,6 +154,7 @@ #if defined(ETH)
/** @defgroup ETH ETH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ETH HAL module driver
* @{
*/
@@ -196,6 +197,7 @@ /* Private macros ------------------------------------------------------------*/
/** @defgroup ETH_Private_Macros ETH Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Helper macros for TX descriptor handling */
@@ -216,6 +218,7 @@ */
/* Private function prototypes -----------------------------------------------*/
/** @defgroup ETH_Private_Functions ETH Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void ETH_MAC_MDIO_ClkConfig(ETH_HandleTypeDef *heth);
@@ -235,10 +238,12 @@ static void ETH_InitCallbacksToDefault(ETH_HandleTypeDef *heth); /* Exported functions ---------------------------------------------------------*/
/** @defgroup ETH_Exported_Functions ETH Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ETH_Exported_Functions_Group1 Initialization and deinitialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -732,6 +737,7 @@ HAL_StatusTypeDef HAL_ETH_DescAssignMemory(ETH_HandleTypeDef *heth, uint32_t Ind */
/** @defgroup ETH_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ETH Transmit and Receive functions
*
@verbatim
@@ -1865,6 +1871,7 @@ HAL_StatusTypeDef HAL_ETH_WritePHYRegister(ETH_HandleTypeDef *heth, uint32_t PHY */
/** @defgroup ETH_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ETH control functions
*
@verbatim
@@ -2309,6 +2316,7 @@ HAL_StatusTypeDef HAL_ETH_SetWakeUpFilter(ETH_HandleTypeDef *heth, uint32_t *pFi */
/** @defgroup ETH_Exported_Functions_Group4 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ETH State and Errors functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth_ex.c index 894443db6d..e506133641 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_eth_ex.c @@ -30,6 +30,7 @@ #if defined(ETH)
/** @defgroup ETHEx ETHEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief ETH HAL Extended module driver
* @{
*/
@@ -38,6 +39,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup ETHEx_Private_Constants ETHEx Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MACL4CR_MASK (ETH_MACL3L4CR_L4PEN | ETH_MACL3L4CR_L4SPM | \
@@ -66,10 +68,12 @@ /* Private function prototypes -----------------------------------------------*/
/* Exported functions ---------------------------------------------------------*/
/** @defgroup ETHEx_Exported_Functions ETH Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ETHEx_Exported_Functions_Group1 Extended features functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended features functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_exti.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_exti.c index ffb5deeffb..8c3366879d 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_exti.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_exti.c @@ -133,6 +133,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private defines ------------------------------------------------------------*/
/** @defgroup EXTI_Private_Constants EXTI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EXTI_MODE_OFFSET 0x04U /* 0x10: offset between CPU IMR/EMR registers */
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_fdcan.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_fdcan.c index 7505fd5a16..41b85c2f78 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_fdcan.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_fdcan.c @@ -190,6 +190,7 @@ */
/** @defgroup FDCAN FDCAN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FDCAN HAL module driver
* @{
*/
@@ -253,10 +254,12 @@ static void FDCAN_CopyMessageToRAM(FDCAN_HandleTypeDef *hfdcan, FDCAN_TxHeaderTy /* Exported functions --------------------------------------------------------*/
/** @defgroup FDCAN_Exported_Functions FDCAN Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FDCAN_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -1605,6 +1608,7 @@ HAL_StatusTypeDef HAL_FDCAN_UnRegisterTTGlobalTimeCallback(FDCAN_HandleTypeDef * */
/** @defgroup FDCAN_Exported_Functions_Group2 Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FDCAN Configuration functions.
*
@verbatim
@@ -2538,6 +2542,7 @@ HAL_StatusTypeDef HAL_FDCAN_DisableEdgeFiltering(FDCAN_HandleTypeDef *hfdcan) */
/** @defgroup FDCAN_Exported_Functions_Group3 Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Control functions
*
@verbatim
@@ -3389,6 +3394,7 @@ HAL_StatusTypeDef HAL_FDCAN_ExitRestrictedOperationMode(FDCAN_HandleTypeDef *hfd */
/** @defgroup FDCAN_Exported_Functions_Group4 TT Configuration and control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TT Configuration and control functions
*
@verbatim
@@ -4886,6 +4892,7 @@ HAL_StatusTypeDef HAL_FDCAN_TT_GetOperationStatus(FDCAN_HandleTypeDef *hfdcan, F */
/** @defgroup FDCAN_Exported_Functions_Group5 Interrupts management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Interrupts management
*
@verbatim
@@ -5605,6 +5612,7 @@ void HAL_FDCAN_IRQHandler(FDCAN_HandleTypeDef *hfdcan) */
/** @defgroup FDCAN_Exported_Functions_Group6 Callback functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FDCAN Callback functions
*
@verbatim
@@ -5949,6 +5957,7 @@ __weak void HAL_FDCAN_TT_GlobalTimeCallback(FDCAN_HandleTypeDef *hfdcan, uint32_ */
/** @defgroup FDCAN_Exported_Functions_Group7 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FDCAN Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash.c index 3a6b651fdc..bcd84ab669 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash.c @@ -93,6 +93,7 @@ */
/** @defgroup FLASH FLASH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FLASH HAL module driver
* @{
*/
@@ -116,10 +117,12 @@ FLASH_ProcessTypeDef pFlash; /* Exported functions ---------------------------------------------------------*/
/** @defgroup FLASH_Exported_Functions FLASH Exported functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FLASH_Exported_Functions_Group1 Programming operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Programming operation functions
*
@verbatim
@@ -681,6 +684,7 @@ __weak void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue) */
/** @defgroup FLASH_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Management functions
*
@verbatim
@@ -836,6 +840,7 @@ HAL_StatusTypeDef HAL_FLASH_OB_Launch(void) */
/** @defgroup FLASH_Exported_Functions_Group3 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Errors functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash_ex.c index 77b809f76b..8c95d707a0 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_flash_ex.c @@ -79,6 +79,7 @@ */
/** @defgroup FLASHEx FLASHEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FLASH HAL Extension module driver
* @{
*/
@@ -99,6 +100,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup FLASHEx_Private_Functions FLASHEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void FLASH_MassErase(uint32_t VoltageRange, uint32_t Banks);
@@ -135,10 +137,12 @@ static uint32_t FLASH_OB_OTP_GetLock(void); /* Exported functions ---------------------------------------------------------*/
/** @defgroup FLASHEx_Exported_Functions FLASHEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FLASHEx_Exported_Functions_Group1 Extended IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended IO operation functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_gfxmmu.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_gfxmmu.c index b873c73bfd..743244fcbf 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_gfxmmu.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_gfxmmu.c @@ -143,6 +143,7 @@ #ifdef HAL_GFXMMU_MODULE_ENABLED
#if defined(GFXMMU)
/** @defgroup GFXMMU GFXMMU
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GFXMMU HAL driver module
* @{
*/
@@ -157,10 +158,12 @@ /* Private function prototypes -----------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup GFXMMU_Exported_Functions GFXMMU Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GFXMMU_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions
*
@verbatim
@@ -492,6 +495,7 @@ HAL_StatusTypeDef HAL_GFXMMU_UnRegisterCallback(GFXMMU_HandleTypeDef *hgf */
/** @defgroup GFXMMU_Exported_Functions_Group2 Operations functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GFXMMU operation functions
*
@verbatim
@@ -823,6 +827,7 @@ __weak void HAL_GFXMMU_ErrorCallback(GFXMMU_HandleTypeDef *hgfxmmu) */
/** @defgroup GFXMMU_Exported_Functions_Group3 State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GFXMMU state functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_gpio.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_gpio.c index 4026ecefce..eff43bcaa4 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_gpio.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_gpio.c @@ -111,6 +111,7 @@ */
/** @defgroup GPIO GPIO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GPIO HAL module driver
* @{
*/
@@ -145,10 +146,12 @@ /* Private functions ---------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup GPIO_Exported_Functions GPIO Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -371,6 +374,7 @@ void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin) */
/** @defgroup GPIO_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GPIO Read, Write, Toggle, Lock and EXTI management functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash.c index 22b4362526..d2bdf69bfc 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash.c @@ -212,6 +212,7 @@ #if defined (HASH)
/** @defgroup HASH HASH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH HAL module driver.
* @{
*/
@@ -221,10 +222,12 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup HASH_Private_Constants HASH Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HASH_Digest_Calculation_Status HASH Digest Calculation Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_DIGEST_CALCULATION_NOT_STARTED ((uint32_t)0x00000000U) /*!< DCAL not set after input data written in DIN register */
@@ -234,6 +237,7 @@ */
/** @defgroup HASH_Number_Of_CSR_Registers HASH Number of Context Swap Registers
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_NUMBER_OF_CSR_REGISTERS 54U /*!< Number of Context Swap Registers */
@@ -242,6 +246,7 @@ */
/** @defgroup HASH_TimeOut_Value HASH TimeOut Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_TIMEOUTVALUE 1000U /*!< Time-out value */
@@ -250,6 +255,7 @@ */
/** @defgroup HASH_DMA_Suspension_Words_Limit HASH DMA suspension words limit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_DMA_SUSPENSION_WORDS_LIMIT 20U /*!< Number of words below which DMA suspension is aborted */
@@ -265,6 +271,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup HASH_Private_Functions HASH Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void HASH_DMAXferCplt(DMA_HandleTypeDef *hdma);
@@ -280,10 +287,12 @@ static HAL_StatusTypeDef HMAC_Processing(HASH_HandleTypeDef *hhash, uint32_t Tim */
/** @defgroup HASH_Exported_Functions HASH Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HASH_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization, configuration and call-back functions.
*
@verbatim
@@ -718,6 +727,7 @@ HAL_StatusTypeDef status = HAL_OK; */
/** @defgroup HASH_Exported_Functions_Group2 HASH processing functions in polling mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH processing functions using polling mode.
*
@verbatim
@@ -863,6 +873,7 @@ HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt_End(HASH_HandleTypeDef *hhash, uint8_t *p */
/** @defgroup HASH_Exported_Functions_Group3 HASH processing functions in interrupt mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH processing functions using interrupt mode.
*
@verbatim
@@ -1025,6 +1036,7 @@ void HAL_HASH_IRQHandler(HASH_HandleTypeDef *hhash) */
/** @defgroup HASH_Exported_Functions_Group4 HASH processing functions in DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH processing functions using DMA mode.
*
@verbatim
@@ -1118,6 +1130,7 @@ HAL_StatusTypeDef HAL_HASH_SHA1_Finish(HASH_HandleTypeDef *hhash, uint8_t* pOutB */
/** @defgroup HASH_Exported_Functions_Group5 HMAC processing functions in polling mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC processing functions using polling mode.
*
@verbatim
@@ -1178,6 +1191,7 @@ HAL_StatusTypeDef HAL_HMAC_SHA1_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuf /** @defgroup HASH_Exported_Functions_Group6 HMAC processing functions in interrupt mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC processing functions using interrupt mode.
*
@verbatim
@@ -1237,6 +1251,7 @@ HAL_StatusTypeDef HAL_HMAC_SHA1_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pIn /** @defgroup HASH_Exported_Functions_Group7 HMAC processing functions in DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC processing functions using DMA modes.
*
@verbatim
@@ -1313,6 +1328,7 @@ HAL_StatusTypeDef HAL_HMAC_SHA1_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pI */
/** @defgroup HASH_Exported_Functions_Group8 Peripheral states functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
@@ -1612,6 +1628,7 @@ uint32_t HAL_HASH_GetError(HASH_HandleTypeDef *hhash) */
/** @defgroup HASH_Private_Functions HASH Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash_ex.c index 13939d6151..0f8b177139 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hash_ex.c @@ -93,6 +93,7 @@ #if defined (HASH)
/** @defgroup HASHEx HASHEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH HAL extended module driver.
* @{
*/
@@ -103,10 +104,12 @@ /** @defgroup HASHEx_Exported_Functions HASH Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HASHEx_Exported_Functions_Group1 HASH extended processing functions in polling mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH extended processing functions using polling mode.
*
@verbatim
@@ -253,6 +256,7 @@ HAL_StatusTypeDef HAL_HASHEx_SHA256_Accmlt_End(HASH_HandleTypeDef *hhash, uint8_ */
/** @defgroup HASHEx_Exported_Functions_Group2 HASH extended processing functions in interrupt mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH extended processing functions using interrupt mode.
*
@verbatim
@@ -384,6 +388,7 @@ HAL_StatusTypeDef HAL_HASHEx_SHA256_Accmlt_End_IT(HASH_HandleTypeDef *hhash, uin */
/** @defgroup HASHEx_Exported_Functions_Group3 HASH extended processing functions in DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HASH extended processing functions using DMA mode.
*
@verbatim
@@ -480,6 +485,7 @@ HAL_StatusTypeDef HAL_HASHEx_SHA256_Finish(HASH_HandleTypeDef *hhash, uint8_t* p */
/** @defgroup HASHEx_Exported_Functions_Group4 HMAC extended processing functions in polling mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC extended processing functions using polling mode.
*
@verbatim
@@ -541,6 +547,7 @@ HAL_StatusTypeDef HAL_HMACEx_SHA256_Start(HASH_HandleTypeDef *hhash, uint8_t *pI /** @defgroup HASHEx_Exported_Functions_Group5 HMAC extended processing functions in interrupt mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC extended processing functions using interruption mode.
*
@verbatim
@@ -603,6 +610,7 @@ HAL_StatusTypeDef HAL_HMACEx_SHA256_Start_IT(HASH_HandleTypeDef *hhash, uint8_t /** @defgroup HASHEx_Exported_Functions_Group6 HMAC extended processing functions in DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC extended processing functions using DMA mode.
*
@verbatim
@@ -681,6 +689,7 @@ HAL_StatusTypeDef HAL_HMACEx_SHA256_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t */
/** @defgroup HASHEx_Exported_Functions_Group7 Multi-buffer HMAC extended processing functions in DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HMAC extended processing functions in multi-buffer DMA mode.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hcd.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hcd.c index 974be7f9b0..52722a43ea 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hcd.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hcd.c @@ -65,6 +65,7 @@ #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
/** @defgroup HCD HCD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HCD HAL module driver
* @{
*/
@@ -75,6 +76,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup HCD_Private_Functions HCD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void HCD_HC_IN_IRQHandler(HCD_HandleTypeDef *hhcd, uint8_t chnum);
@@ -87,10 +89,12 @@ static void HCD_Port_IRQHandler(HCD_HandleTypeDef *hhcd); /* Exported functions --------------------------------------------------------*/
/** @defgroup HCD_Exported_Functions HCD Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -327,6 +331,7 @@ __weak void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd) */
/** @defgroup HCD_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HCD IO operation functions
*
@verbatim
@@ -982,6 +987,7 @@ HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef */
/** @defgroup HCD_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Management functions
*
@verbatim
@@ -1041,6 +1047,7 @@ HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd) */
/** @defgroup HCD_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hrtim.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hrtim.c index 4f78ecf665..ee54e81de8 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hrtim.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hrtim.c @@ -366,6 +366,7 @@ #if defined(HRTIM1)
/** @defgroup HRTIM HRTIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HRTIM HAL module driver
* @{
*/
@@ -373,6 +374,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup HRTIM_Private_Defines HRTIM Private Define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_FLTR_FLTxEN (HRTIM_FLTR_FLT1EN |\
@@ -402,6 +404,7 @@ /* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup HRTIM_Private_Variables HRTIM Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t TimerIdxToTimerId[] =
@@ -419,6 +422,7 @@ static uint32_t TimerIdxToTimerId[] = /* Private function prototypes -----------------------------------------------*/
/** @defgroup HRTIM_Private_Functions HRTIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void HRTIM_MasterBase_Config(HRTIM_HandleTypeDef * hhrtim,
@@ -491,10 +495,12 @@ static void HRTIM_BurstDMACplt(DMA_HandleTypeDef *hdma); /* Exported functions ---------------------------------------------------------*/
/** @defgroup HRTIM_Exported_Functions HRTIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HRTIM_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
@verbatim
===============================================================================
@@ -778,6 +784,7 @@ HAL_StatusTypeDef HAL_HRTIM_TimeBaseConfig(HRTIM_HandleTypeDef *hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group2 Simple time base mode functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Simple time base mode functions.
@verbatim
===============================================================================
@@ -1146,6 +1153,7 @@ HAL_StatusTypeDef HAL_HRTIM_SimpleBaseStop_DMA(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group3 Simple output compare mode functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Simple output compare functions
@verbatim
===============================================================================
@@ -1757,6 +1765,7 @@ HAL_StatusTypeDef HAL_HRTIM_SimpleOCStop_DMA(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group4 Simple PWM output mode functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Simple PWM output functions
@verbatim
===============================================================================
@@ -2438,6 +2447,7 @@ HAL_StatusTypeDef HAL_HRTIM_SimplePWMStop_DMA(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group5 Simple input capture functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Simple input capture functions
@verbatim
===============================================================================
@@ -3078,6 +3088,7 @@ HAL_StatusTypeDef HAL_HRTIM_SimpleCaptureStop_DMA(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group6 Simple one pulse functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Simple one pulse functions
@verbatim
===============================================================================
@@ -3532,6 +3543,7 @@ HAL_StatusTypeDef HAL_HRTIM_SimpleOnePulseStop_IT(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group7 Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HRTIM configuration functions
@verbatim
===============================================================================
@@ -4036,6 +4048,7 @@ HAL_StatusTypeDef HAL_HRTIM_ADCTriggerConfig(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group8 Timer waveform configuration and functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HRTIM timer configuration and control functions
@verbatim
===============================================================================
@@ -5895,6 +5908,7 @@ HAL_StatusTypeDef HAL_HRTIM_UpdateDisable(HRTIM_HandleTypeDef *hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group9 Peripheral state functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
@verbatim
===============================================================================
@@ -6379,6 +6393,7 @@ uint32_t HAL_HRTIM_GetIdlePushPullStatus(HRTIM_HandleTypeDef * hhrtim, */
/** @defgroup HRTIM_Exported_Functions_Group10 Interrupts handling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Functions called when HRTIM generates an interrupt
* 7 interrupts can be generated by the master timer:
* - Master timer registers update
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hsem.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hsem.c index 1fab0cefa5..7a6be9c805 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_hsem.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_hsem.c @@ -92,6 +92,7 @@ */
/** @defgroup HSEM HSEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HSEM HAL module driver
* @{
*/
@@ -120,10 +121,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup HSEM_Exported_Functions HSEM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HSEM_Exported_Functions_Group1 Take and Release functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HSEM Take and Release functions
*
@verbatim
@@ -260,6 +263,7 @@ void HAL_HSEM_ReleaseAll(uint32_t Key, uint32_t CoreID) */
/** @defgroup HSEM_Exported_Functions_Group2 HSEM Set and Get Key functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HSEM Set and Get Key functions.
*
@verbatim
@@ -301,6 +305,7 @@ uint32_t HAL_HSEM_GetClearKey(void) */
/** @defgroup HSEM_Exported_Functions_Group3 HSEM IRQ handler management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HSEM Notification functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c.c index 7c05d16f6f..aedffac024 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c.c @@ -312,6 +312,7 @@ */
/** @defgroup I2C I2C
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C HAL module driver
* @{
*/
@@ -322,6 +323,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup I2C_Private_Define I2C Private Define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIMING_CLEAR_MASK (0xF0FFFFFFU) /*!< I2C TIMING clear register Mask */
@@ -370,6 +372,7 @@ /* Private function prototypes -----------------------------------------------*/
/** @defgroup I2C_Private_Functions I2C Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions to handle DMA transfer */
@@ -428,10 +431,12 @@ static void I2C_ConvertOtherXferOptions(I2C_HandleTypeDef *hi2c); /* Exported functions --------------------------------------------------------*/
/** @defgroup I2C_Exported_Functions I2C Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -977,6 +982,7 @@ HAL_StatusTypeDef HAL_I2C_UnRegisterAddrCallback(I2C_HandleTypeDef *hi2c) */
/** @defgroup I2C_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -4300,6 +4306,7 @@ HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevA */
/** @defgroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4539,6 +4546,7 @@ __weak void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c) */
/** @defgroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State, Mode and Error functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c_ex.c index ea50ce31c5..a1863bc177 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2c_ex.c @@ -54,6 +54,7 @@ */
/** @defgroup I2CEx I2CEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C Extended HAL module driver
* @{
*/
@@ -68,10 +69,12 @@ /* Private functions ---------------------------------------------------------*/
/** @defgroup I2CEx_Exported_Functions I2C Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2CEx_Exported_Functions_Group1 Extended features functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended features functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2s.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2s.c index 1a6bec0451..e6f43c542e 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2s.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_i2s.c @@ -183,6 +183,7 @@ */
/** @defgroup I2S I2S
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2S HAL module driver
* @{
*/
@@ -195,6 +196,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup I2S_Private_Functions I2S Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void I2S_DMATxCplt(DMA_HandleTypeDef *hdma);
@@ -215,10 +217,12 @@ static HAL_StatusTypeDef I2S_WaitFlagStateUntilTimeout(I2S_HandleTypeDef *hi2s, /* Exported functions ---------------------------------------------------------*/
/** @defgroup I2S_Exported_Functions I2S Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2S_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -718,6 +722,7 @@ HAL_StatusTypeDef HAL_I2S_UnRegisterCallback(I2S_HandleTypeDef *hi2s, HAL_I2S_Ca */
/** @defgroup I2S_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -1613,6 +1618,7 @@ __weak void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s) */
/** @defgroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_irda.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_irda.c index 2d9f808115..0124dd508d 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_irda.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_irda.c @@ -192,6 +192,7 @@ */
/** @defgroup IRDA IRDA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL IRDA module driver
* @{
*/
@@ -201,6 +202,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup IRDA_Private_Constants IRDA Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_TEACK_REACK_TIMEOUT 1000U /*!< IRDA TX or RX enable acknowledge time-out value */
@@ -217,6 +219,7 @@ /* Private macros ------------------------------------------------------------*/
/** @defgroup IRDA_Private_Macros IRDA Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief BRR division operation to set BRR register in 16-bit oversampling mode.
@@ -265,10 +268,12 @@ static void IRDA_Receive_IT(IRDA_HandleTypeDef *hirda); /* Exported functions --------------------------------------------------------*/
/** @defgroup IRDA_Exported_Functions IRDA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -702,6 +707,7 @@ HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRD */
/** @defgroup IRDA_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IRDA Transmit and Receive functions
*
@verbatim
@@ -2146,6 +2152,7 @@ __weak void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda) */
/** @defgroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IRDA State and Errors functions
*
@verbatim
@@ -2201,6 +2208,7 @@ uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda) */
/** @defgroup IRDA_Private_Functions IRDA Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_iwdg.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_iwdg.c index 9947bf6a87..a10d003eb6 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_iwdg.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_iwdg.c @@ -107,6 +107,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup IWDG_Private_Defines IWDG Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Status register need 5 RC LSI divided by prescaler clock to be updated. With
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_jpeg.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_jpeg.c index 80b34314a1..74f8b52add 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_jpeg.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_jpeg.c @@ -224,6 +224,7 @@ */
/** @defgroup JPEG JPEG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG HAL module driver.
* @{
*/
@@ -456,10 +457,12 @@ static void JPEG_MDMAOutAbortCallback(MDMA_HandleTypeDef *hmdma); */
/** @defgroup JPEG_Exported_Functions JPEG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup JPEG_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions.
*
@verbatim
@@ -1072,6 +1075,7 @@ HAL_StatusTypeDef HAL_JPEG_UnRegisterDataReadyCallback(JPEG_HandleTypeDef *hjpeg */
/** @defgroup JPEG_Exported_Functions_Group2 Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Configuration functions.
*
@verbatim
@@ -1484,6 +1488,7 @@ HAL_StatusTypeDef HAL_JPEG_SetUserQuantTables(JPEG_HandleTypeDef *hjpeg, uint8_ */
/** @defgroup JPEG_Exported_Functions_Group3 encoding/decoding processing functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief processing functions.
*
@verbatim
@@ -2290,6 +2295,7 @@ HAL_StatusTypeDef HAL_JPEG_Abort(JPEG_HandleTypeDef *hjpeg) */
/** @defgroup JPEG_Exported_Functions_Group4 JPEG Decode/Encode callback functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG process callback functions.
*
@verbatim
@@ -2419,6 +2425,7 @@ __weak void HAL_JPEG_DataReadyCallback(JPEG_HandleTypeDef *hjpeg, uint8_t *pData /** @defgroup JPEG_Exported_Functions_Group5 JPEG IRQ handler management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG IRQ handler.
*
@verbatim
@@ -2470,6 +2477,7 @@ void HAL_JPEG_IRQHandler(JPEG_HandleTypeDef *hjpeg) */
/** @defgroup JPEG_Exported_Functions_Group6 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_lptim.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_lptim.c index 5e03de3b94..88a38db1c8 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_lptim.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_lptim.c @@ -164,6 +164,7 @@ */
/** @defgroup LPTIM LPTIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief LPTIM HAL module driver.
* @{
*/
@@ -193,10 +194,12 @@ static HAL_StatusTypeDef LPTIM_WaitForFlag(LPTIM_HandleTypeDef *hlptim, uint32_t /* Exported functions --------------------------------------------------------*/
/** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPTIM_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions.
*
@verbatim
@@ -443,6 +446,7 @@ __weak void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim) */
/** @defgroup LPTIM_Exported_Functions_Group2 LPTIM Start-Stop operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Start-Stop operation functions.
*
@verbatim
@@ -1729,6 +1733,7 @@ HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim) */
/** @defgroup LPTIM_Exported_Functions_Group3 LPTIM Read operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Read operation functions.
*
@verbatim
@@ -1787,6 +1792,7 @@ uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef *hlptim) */
/** @defgroup LPTIM_Exported_Functions_Group4 LPTIM IRQ handler and callbacks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief LPTIM IRQ handler.
*
@verbatim
@@ -2255,6 +2261,7 @@ HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *hlpti */
/** @defgroup LPTIM_Group5 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
@@ -2291,6 +2298,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim) /* Private functions ---------------------------------------------------------*/
/** @defgroup LPTIM_Private_Functions LPTIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc.c index a3ddbeec46..e794f3c9dc 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc.c @@ -171,6 +171,7 @@ #if defined (LTDC)
/** @defgroup LTDC LTDC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief LTDC HAL module driver
* @{
*/
@@ -185,10 +186,12 @@ static void LTDC_SetConfig(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLay /* Private functions ---------------------------------------------------------*/
/** @defgroup LTDC_Exported_Functions LTDC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LTDC_Exported_Functions_Group1 Initialization and Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -563,6 +566,7 @@ HAL_StatusTypeDef HAL_LTDC_UnRegisterCallback(LTDC_HandleTypeDef *hltdc, HAL_LTD */
/** @defgroup LTDC_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -746,6 +750,7 @@ __weak void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc) */
/** @defgroup LTDC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -2015,6 +2020,7 @@ HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint3 */
/** @defgroup LTDC_Exported_Functions_Group4 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State and Errors functions
*
@verbatim
@@ -2061,6 +2067,7 @@ uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc) */
/** @defgroup LTDC_Private_Functions LTDC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc_ex.c index b0bafd74cd..d13c6e7cc8 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ltdc_ex.c @@ -29,6 +29,7 @@ #if defined (LTDC) && defined (DSI)
/** @defgroup LTDCEx LTDCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief LTDC HAL module driver
* @{
*/
@@ -41,10 +42,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup LTDCEx_Exported_Functions LTDC Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LTDCEx_Exported_Functions_Group1 Initialization and Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdios.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdios.c index b08894ee4a..987c0d7244 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdios.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdios.c @@ -134,6 +134,7 @@ */
#if defined (MDIOS)
/** @defgroup MDIOS MDIOS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL MDIOS module driver
* @{
*/
@@ -159,10 +160,12 @@ static void MDIOS_InitCallbacksToDefault(MDIOS_HandleTypeDef *hmdios); /* Private functions ---------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup MDIOS_Exported_Functions MDIOS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDIOS_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -530,6 +533,7 @@ HAL_StatusTypeDef HAL_MDIOS_UnRegisterCallback(MDIOS_HandleTypeDef *hmdios, HAL_ */
/** @defgroup MDIOS_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDIOS Read/Write functions
*
@verbatim
@@ -886,6 +890,7 @@ __weak void HAL_MDIOS_WakeUpCallback(MDIOS_HandleTypeDef *hmdios) */
/** @defgroup MDIOS_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDIOS control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdma.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdma.c index 08498c4605..8dd757acf6 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdma.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mdma.c @@ -155,6 +155,7 @@ */
/** @defgroup MDMA MDMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc.c index 6bbb14b79d..e3ab7843c1 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc.c @@ -249,6 +249,7 @@ */
/** @defgroup MMC MMC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MMC HAL module driver
* @{
*/
@@ -270,6 +271,7 @@ /* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
/** @defgroup MMC_Private_Functions MMC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t MMC_InitCard(MMC_HandleTypeDef *hmmc);
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc_ex.c index 8b4d18eafe..aeeedfacbc 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_mmc_ex.c @@ -40,6 +40,7 @@ */
/** @defgroup MMCEx MMCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MMC Extended HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_nand.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_nand.c index 4e593adc02..11efedccc3 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_nand.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_nand.c @@ -117,6 +117,7 @@ #ifdef HAL_NAND_MODULE_ENABLED
/** @defgroup NAND NAND
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief NAND HAL module driver
* @{
*/
@@ -129,10 +130,12 @@ /* Exported functions ---------------------------------------------------------*/
/** @defgroup NAND_Exported_Functions NAND Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup NAND_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -356,6 +359,7 @@ __weak void HAL_NAND_ITCallback(NAND_HandleTypeDef *hnand) */
/** @defgroup NAND_Exported_Functions_Group2 Input and Output functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Input Output and memory control functions
*
@verbatim
@@ -1979,6 +1983,7 @@ HAL_StatusTypeDef HAL_NAND_UnRegisterCallback (NAND_HandleTypeDef *hnand, HAL_NA */
/** @defgroup NAND_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -2100,6 +2105,7 @@ HAL_StatusTypeDef HAL_NAND_GetECC(NAND_HandleTypeDef *hnand, uint32_t *ECCval, /** @defgroup NAND_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_nor.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_nor.c index b58b8cfd79..baaa093720 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_nor.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_nor.c @@ -114,6 +114,7 @@ #ifdef HAL_NOR_MODULE_ENABLED
/** @defgroup NOR NOR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief NOR driver modules
* @{
*/
@@ -122,6 +123,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup NOR_Private_Defines NOR Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -161,6 +163,7 @@ /* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup NOR_Private_Variables NOR Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -173,10 +176,12 @@ static uint32_t uwNORMemoryDataWidth = NOR_MEMORY_8B; /* Private functions ---------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup NOR_Exported_Functions NOR Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup NOR_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -345,6 +350,7 @@ __weak void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout) */
/** @defgroup NOR_Exported_Functions_Group2 Input and Output functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Input Output and memory control functions
*
@verbatim
@@ -1085,6 +1091,7 @@ HAL_StatusTypeDef HAL_NOR_UnRegisterCallback (NOR_HandleTypeDef *hnor, HAL_NOR_C */
/** @defgroup NOR_Exported_Functions_Group3 NOR Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -1172,6 +1179,7 @@ HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor) */
/** @defgroup NOR_Exported_Functions_Group4 NOR State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp.c index 21f75b010a..d4a5991589 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp.c @@ -215,6 +215,7 @@ */
/** @defgroup OPAMP OPAMP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OPAMP module driver
* @{
*/
@@ -252,10 +253,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup OPAMP_Exported_Functions OPAMP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMP_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -510,6 +513,7 @@ __weak void HAL_OPAMP_MspDeInit(OPAMP_HandleTypeDef *hopamp) /** @defgroup OPAMP_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
@@ -833,6 +837,7 @@ HAL_StatusTypeDef HAL_OPAMP_SelfCalibrate(OPAMP_HandleTypeDef *hopamp) */
/** @defgroup OPAMP_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -974,6 +979,7 @@ HAL_OPAMP_TrimmingValueTypeDef HAL_OPAMP_GetTrimOffset (OPAMP_HandleTypeDef *hop /** @defgroup OPAMP_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp_ex.c index 3ad48a5f64..cbec711388 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_opamp_ex.c @@ -32,6 +32,7 @@ */
/** @defgroup OPAMPEx OPAMPEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OPAMP Extended HAL module driver
* @{
*/
@@ -46,10 +47,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup OPAMPEx_Exported_Functions OPAMP Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMPEx_Exported_Functions_Group1 Extended Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended operation functions
*
@verbatim
@@ -368,6 +371,7 @@ HAL_StatusTypeDef HAL_OPAMPEx_SelfCalibrateAll(OPAMP_HandleTypeDef *hopamp1, OPA */
/** @defgroup OPAMPEx_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ospi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ospi.c index 6036974978..ab62817851 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ospi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ospi.c @@ -244,6 +244,7 @@ */
/** @defgroup OSPI OSPI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OSPI HAL module driver
* @{
*/
@@ -290,10 +291,12 @@ static HAL_StatusTypeDef OSPIM_GetConfig (uint8_t instance_nb, OSP /* Exported functions --------------------------------------------------------*/
/** @defgroup OSPI_Exported_Functions OSPI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OSPI_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -518,6 +521,7 @@ __weak void HAL_OSPI_MspDeInit(OSPI_HandleTypeDef *hospi) */
/** @defgroup OSPI_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OSPI Transmit/Receive functions
*
@verbatim
@@ -2178,6 +2182,7 @@ HAL_StatusTypeDef HAL_OSPI_UnRegisterCallback (OSPI_HandleTypeDef *hospi, HAL_OS */
/** @defgroup OSPI_Exported_Functions_Group3 Peripheral Control and State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OSPI control and State functions
*
@verbatim
@@ -2417,6 +2422,7 @@ uint32_t HAL_OSPI_GetState(OSPI_HandleTypeDef *hospi) */
/** @defgroup OSPI_Exported_Functions_Group4 IO Manager configuration function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OSPI IO Manager configuration function
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_otfdec.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_otfdec.c index e4ace0de90..af7dcd0191 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_otfdec.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_otfdec.c @@ -132,6 +132,7 @@ */
/** @defgroup OTFDEC OTFDEC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OTFDEC HAL module driver.
* @{
*/
@@ -156,6 +157,7 @@ */
/** @defgroup OTFDEC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions.
*
@verbatim
@@ -456,6 +458,7 @@ HAL_StatusTypeDef HAL_OTFDEC_UnRegisterCallback(OTFDEC_HandleTypeDef *hotfdec, H */
/** @defgroup OTFDEC_Exported_Functions_Group2 OTFDEC IRQ handler management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OTFDEC IRQ handler.
*
@verbatim
@@ -526,6 +529,7 @@ __weak void HAL_OTFDEC_ErrorCallback(OTFDEC_HandleTypeDef *hotfdec) /** @defgroup OTFDEC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral control functions.
*
@verbatim
@@ -875,6 +879,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionDisable(OTFDEC_HandleTypeDef *hotfdec, uint32 */
/** @defgroup OTFDEC_Exported_Functions_Group4 Peripheral State and Status functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions.
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd.c index 3a847e8757..497cd106a0 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd.c @@ -62,6 +62,7 @@ */
/** @defgroup PCD PCD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PCD HAL module driver
* @{
*/
@@ -75,6 +76,7 @@ /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup PCD_Private_Macros PCD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PCD_MIN(a, b) (((a) < (b)) ? (a) : (b))
@@ -85,6 +87,7 @@ /* Private functions prototypes ----------------------------------------------*/
/** @defgroup PCD_Private_Functions PCD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
@@ -98,10 +101,12 @@ static HAL_StatusTypeDef PCD_EP_OutSetupPacket_int(PCD_HandleTypeDef *hpcd, uint /* Exported functions --------------------------------------------------------*/
/** @defgroup PCD_Exported_Functions PCD Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PCD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -968,6 +973,7 @@ HAL_StatusTypeDef HAL_PCD_UnRegisterLpmCallback(PCD_HandleTypeDef *hpcd) */
/** @defgroup PCD_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -1593,6 +1599,7 @@ __weak void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd) */
/** @defgroup PCD_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -1946,6 +1953,7 @@ HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup(PCD_HandleTypeDef *hpcd) */
/** @defgroup PCD_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd_ex.c index 17d3d5b05a..9bd08fd8b9 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pcd_ex.c @@ -29,6 +29,7 @@ */
/** @defgroup PCDEx PCDEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PCD Extended HAL module driver
* @{
*/
@@ -44,10 +45,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup PCDEx_Exported_Functions PCDEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PCDEx_Exported_Functions_Group1 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PCDEx control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pssi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pssi.c index e14f97f916..7ca7d5ad9f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pssi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pssi.c @@ -153,6 +153,7 @@ */
/** @defgroup PSSI PSSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PSSI HAL module driver
* @{
*/
@@ -163,6 +164,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup PSSI_Private_Define PSSI Private Define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -177,6 +179,7 @@ /* Private function prototypes -----------------------------------------------*/
/** @defgroup PSSI_Private_Functions PSSI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions to handle DMA transfer */
@@ -199,10 +202,12 @@ static HAL_StatusTypeDef PSSI_WaitOnStatusUntilTimeout(PSSI_HandleTypeDef *hpssi /* Exported functions --------------------------------------------------------*/
/** @defgroup PSSI_Exported_Functions PSSI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PSSI_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -563,6 +568,7 @@ HAL_StatusTypeDef HAL_PSSI_UnRegisterCallback(PSSI_HandleTypeDef *hpssi, HAL_PSS */
/** @defgroup PSSI_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -1271,6 +1277,7 @@ HAL_StatusTypeDef HAL_PSSI_Abort_DMA(PSSI_HandleTypeDef *hpssi) */
/** @defgroup PSSI_Exported_Functions_Group3 IRQ Handler and Callbacks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1451,6 +1458,7 @@ __weak void HAL_PSSI_AbortCpltCallback(PSSI_HandleTypeDef *hpssi) */
/** @defgroup PSSI_Exported_Functions_Group4 Peripheral State, Mode and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State, Mode and Error functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr.c index 43d9052a2c..5620ce7227 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr.c @@ -152,6 +152,7 @@ */
/** @defgroup PWR PWR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PWR HAL module driver
* @{
*/
@@ -166,6 +167,7 @@ */
/** @defgroup PWR_PVD_Mode_Mask PWR PVD Mode Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if !defined (DUAL_CORE)
@@ -190,10 +192,12 @@ /* Private functions ---------------------------------------------------------*/
/** @defgroup PWR_Exported_Functions PWR Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_Exported_Functions_Group1 Initialization and De-Initialization Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and De-Initialization functions
*
@verbatim
@@ -258,6 +262,7 @@ void HAL_PWR_DisableBkUpAccess (void) */
/** @defgroup PWR_Exported_Functions_Group2 Peripheral Control Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Power Control functions
*
@verbatim
@@ -777,6 +782,7 @@ void HAL_PWR_DisableSEVOnPend (void) */
/** @defgroup PWR_Exported_Functions_Group3 Interrupt Handling Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Interrupt Handling functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr_ex.c index 82288f9e2f..22d099faf1 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_pwr_ex.c @@ -158,6 +158,7 @@ */
/** @defgroup PWREx PWREx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PWR Extended HAL module driver
* @{
*/
@@ -172,6 +173,7 @@ */
/** @defgroup PWREx_AVD_Mode_Mask PWR Extended AVD Mode Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define AVD_MODE_IT (0x00010000U)
@@ -184,6 +186,7 @@ */
/** @defgroup PWREx_REG_SET_TIMEOUT PWR Extended Flag Setting Time Out Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_FLAG_SETTING_DELAY (1000U)
@@ -192,6 +195,7 @@ */
/** @defgroup PWREx_WakeUp_Pins_Offsets PWREx Wake-Up Pins masks and offsets
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Wake-Up Pins EXTI register mask */
@@ -217,10 +221,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup PWREx_Exported_Functions PWREx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWREx_Exported_Functions_Group1 Power Supply Control Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Power supply control functions
*
@verbatim
@@ -549,6 +555,7 @@ uint32_t HAL_PWREx_GetStopModeVoltageRange (void) */
/** @defgroup PWREx_Exported_Functions_Group2 Low Power Control Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Low power control functions
*
@verbatim
@@ -1501,6 +1508,7 @@ __weak void HAL_PWREx_WKUP6_Callback (void) */
/** @defgroup PWREx_Exported_Functions_Group3 Peripherals control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripherals control functions
*
@verbatim
@@ -1766,6 +1774,7 @@ void HAL_PWREx_DisableAnalogBooster (void) */
/** @defgroup PWREx_Exported_Functions_Group4 Power Monitoring functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Power Monitoring functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_qspi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_qspi.c index b655c6e1d5..36761ab732 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_qspi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_qspi.c @@ -234,6 +234,7 @@ */
/** @defgroup QSPI QSPI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief QSPI HAL module driver
* @{
*/
@@ -243,6 +244,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup QSPI_Private_Constants QSPI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_FUNCTIONAL_MODE_INDIRECT_WRITE 0x00000000U /*!<Indirect write mode*/
@@ -255,6 +257,7 @@ /* Private macro -------------------------------------------------------------*/
/** @defgroup QSPI_Private_Macros QSPI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_QSPI_FUNCTIONAL_MODE(MODE) (((MODE) == QSPI_FUNCTIONAL_MODE_INDIRECT_WRITE) || \
@@ -278,10 +281,12 @@ static void QSPI_Config(QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, uin /* Exported functions --------------------------------------------------------*/
/** @defgroup QSPI_Exported_Functions QSPI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup QSPI_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -465,6 +470,7 @@ __weak void HAL_QSPI_MspDeInit(QSPI_HandleTypeDef *hqspi) */
/** @defgroup QSPI_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief QSPI Transmit/Receive functions
*
@verbatim
@@ -2104,6 +2110,7 @@ HAL_StatusTypeDef HAL_QSPI_UnRegisterCallback (QSPI_HandleTypeDef *hqspi, HAL_QS */
/** @defgroup QSPI_Exported_Functions_Group3 Peripheral Control and State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief QSPI control and State functions
*
@verbatim
@@ -2352,6 +2359,7 @@ HAL_StatusTypeDef HAL_QSPI_SetFlashID(QSPI_HandleTypeDef *hqspi, uint32_t FlashI */
/** @defgroup QSPI_Private_Functions QSPI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ramecc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ramecc.c index fd2776fb8d..28eb8f81f1 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_ramecc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_ramecc.c @@ -91,6 +91,7 @@ */
/** @defgroup RAMECC RAMECC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc.c index 4b303c6c54..c1c934347b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc.c @@ -74,6 +74,7 @@ */
/** @defgroup RCC RCC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RCC HAL module driver
* @{
*/
@@ -84,6 +85,7 @@ /* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/** @defgroup RCC_Private_Macros RCC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MCO1_CLK_ENABLE() __HAL_RCC_GPIOA_CLK_ENABLE()
@@ -99,6 +101,7 @@ */
/* Private variables ---------------------------------------------------------*/
/** @defgroup RCC_Private_Variables RCC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -109,10 +112,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup RCC_Exported_Functions RCC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -1211,6 +1216,7 @@ HAL_StatusTypeDef HAL_RCC_ClockConfig(const RCC_ClkInitTypeDef *RCC_ClkInitStru */
/** @defgroup RCC_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RCC clocks control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc_ex.c index 0aef587505..8fd8ff05ed 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rcc_ex.c @@ -30,6 +30,7 @@ */
/** @defgroup RCCEx RCCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RCC HAL module driver
* @{
*/
@@ -39,6 +40,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private defines -----------------------------------------------------------*/
/** @defgroup RCCEx_Private_defines Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PLL2_TIMEOUT_VALUE PLL_TIMEOUT_VALUE /* 2 ms */
@@ -57,10 +59,12 @@ static HAL_StatusTypeDef RCCEx_PLL3_Config(const RCC_PLL3InitTypeDef *pll3, uint /* Exported functions --------------------------------------------------------*/
/** @defgroup RCCEx_Exported_Functions Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCCEx_Exported_Functions_Group1 Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral Control functions
*
@verbatim
@@ -2673,6 +2677,7 @@ uint32_t common_system_clock; */
/** @defgroup RCCEx_Exported_Functions_Group2 Extended System Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral Control functions
* @{
*/
@@ -2814,6 +2819,7 @@ void HAL_RCCEx_WWDGxSysResetConfig(uint32_t RCC_WWDGx) */
/** @defgroup RCCEx_Exported_Functions_Group3 Extended Clock Recovery System Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Clock Recovery System Control functions
*
@verbatim
@@ -3181,6 +3187,7 @@ __weak void HAL_RCCEx_CRS_ErrorCallback(uint32_t Error) */
/** @defgroup RCCEx_Private_functions Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng.c index b4585ccb98..2f5782fb42 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng.c @@ -111,6 +111,7 @@ /* Private types -------------------------------------------------------------*/
/* Private defines -----------------------------------------------------------*/
/** @defgroup RNG_Private_Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Health test control register information to use in CCM algorithm */
@@ -126,6 +127,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RNG_Private_Constants RNG Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_TIMEOUT_VALUE 2U
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng_ex.c index c71504ffa0..e5c728e50f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_rng_ex.c @@ -41,6 +41,7 @@ /* Private types -------------------------------------------------------------*/
/* Private defines -----------------------------------------------------------*/
/** @defgroup RNGEx_Private_Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Health test control register information to use in CCM algorithm */
@@ -56,6 +57,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RNGEx_Private_Constants RNG Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_TIMEOUT_VALUE 2U
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai.c index a858d8e452..0c5e7f7309 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai.c @@ -221,6 +221,7 @@ */
/** @defgroup SAI SAI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI HAL module driver
* @{
*/
@@ -229,6 +230,7 @@ /* Private typedef -----------------------------------------------------------*/
/** @defgroup SAI_Private_Typedefs SAI Private Typedefs
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -242,6 +244,7 @@ typedef enum /* Private define ------------------------------------------------------------*/
/** @defgroup SAI_Private_Constants SAI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIFO_SIZE 8U
@@ -255,6 +258,7 @@ typedef enum /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup SAI_Private_Functions SAI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void SAI_FillFifo(SAI_HandleTypeDef *hsai);
@@ -282,10 +286,12 @@ static void SAI_DMAAbort(DMA_HandleTypeDef *hdma); /* Exported functions ---------------------------------------------------------*/
/** @defgroup SAI_Exported_Functions SAI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SAI_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -1042,6 +1048,7 @@ HAL_StatusTypeDef HAL_SAI_UnRegisterCallback(SAI_HandleTypeDef *hsai, */
/** @defgroup SAI_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -2203,6 +2210,7 @@ __weak void HAL_SAI_ErrorCallback(SAI_HandleTypeDef *hsai) */
/** @defgroup SAI_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai_ex.c index fd392896b1..14bdce78aa 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sai_ex.c @@ -30,6 +30,7 @@ #ifdef HAL_SAI_MODULE_ENABLED
/** @defgroup SAIEx SAIEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Extended HAL module driver
* @{
*/
@@ -45,10 +46,12 @@ /* Private functions ---------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup SAIEx_Exported_Functions SAIEx Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SAIEx_Exported_Functions_Group1 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAIEx control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd.c index 170930a97f..edafb06def 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd.c @@ -284,6 +284,7 @@ /* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
/** @defgroup SD_Private_Functions SD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t SD_InitCard (SD_HandleTypeDef *hsd);
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd_ex.c index 674619d98b..3c6551180e 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sd_ex.c @@ -39,6 +39,7 @@ */
/** @defgroup SDEx SDEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SD Extended HAL module driver
* @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sdram.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sdram.c index 3b0efe590a..45f308c9e2 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sdram.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sdram.c @@ -122,6 +122,7 @@ #ifdef HAL_SDRAM_MODULE_ENABLED
/** @defgroup SDRAM SDRAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SDRAM driver modules
* @{
*/
@@ -143,10 +144,12 @@ static void SDRAM_DMAError (MDMA_HandleTypeDef *hmdma); /* Exported functions --------------------------------------------------------*/
/** @defgroup SDRAM_Exported_Functions SDRAM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SDRAM_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -354,6 +357,7 @@ __weak void HAL_SDRAM_DMA_XferErrorCallback(MDMA_HandleTypeDef *hmdma) */
/** @defgroup SDRAM_Exported_Functions_Group2 Input and Output functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Input Output and memory control functions
*
@verbatim
@@ -987,6 +991,7 @@ HAL_StatusTypeDef HAL_SDRAM_RegisterDmaCallback(SDRAM_HandleTypeDef *hsdram, HAL */
/** @defgroup SDRAM_Exported_Functions_Group3 Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -1193,6 +1198,7 @@ uint32_t HAL_SDRAM_GetModeStatus(SDRAM_HandleTypeDef *hsdram) */
/** @defgroup SDRAM_Exported_Functions_Group4 State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard.c index 01237b07ca..bc1db12d93 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard.c @@ -187,6 +187,7 @@ */
/** @defgroup SMARTCARD SMARTCARD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL SMARTCARD module driver
* @{
*/
@@ -196,6 +197,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup SMARTCARD_Private_Constants SMARTCARD Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_TEACK_REACK_TIMEOUT 1000U /*!< SMARTCARD TX or RX enable acknowledge time-out value */
@@ -255,10 +257,12 @@ static void SMARTCARD_RxISR_FIFOEN(SMARTCARD_HandleTypeDef *hsmartcard); /* Exported functions --------------------------------------------------------*/
/** @defgroup SMARTCARD_Exported_Functions SMARTCARD Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SMARTCARD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -708,6 +712,7 @@ HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsma */
/** @defgroup SMARTCARD_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD Transmit and Receive functions
*
@verbatim
@@ -2202,6 +2207,7 @@ __weak void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsma */
/** @defgroup SMARTCARD_Exported_Functions_Group4 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD State and Errors functions
*
@verbatim
@@ -2257,6 +2263,7 @@ uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsmartcard) */
/** @defgroup SMARTCARD_Private_Functions SMARTCARD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard_ex.c index 3262fd6da0..4957a016ea 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smartcard_ex.c @@ -48,6 +48,7 @@ */
/** @defgroup SMARTCARDEx SMARTCARDEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD Extended HAL module driver
* @{
*/
@@ -56,6 +57,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup SMARTCARDEx_Private_Constants SMARTCARD Extended Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* UART RX FIFO depth */
@@ -74,10 +76,12 @@ static void SMARTCARDEx_SetNbDataToProcess(SMARTCARD_HandleTypeDef *hsmartcard); /* Exported functions --------------------------------------------------------*/
/** @defgroup SMARTCARDEx_Exported_Functions SMARTCARD Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SMARTCARDEx_Exported_Functions_Group1 Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended control functions
*
@verbatim
@@ -184,6 +188,7 @@ HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef */
/** @defgroup SMARTCARDEx_Exported_Functions_Group2 Extended Peripheral IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD Transmit and Receive functions
*
@verbatim
@@ -238,6 +243,7 @@ __weak void HAL_SMARTCARDEx_TxFifoEmptyCallback(SMARTCARD_HandleTypeDef *hsmartc */
/** @defgroup SMARTCARDEx_Exported_Functions_Group3 Extended Peripheral FIFO Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD control functions
*
@verbatim
@@ -441,6 +447,7 @@ HAL_StatusTypeDef HAL_SMARTCARDEx_SetRxFifoThreshold(SMARTCARD_HandleTypeDef *hs */
/** @defgroup SMARTCARDEx_Private_Functions SMARTCARD Extended Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smbus.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smbus.c index 519756dc7d..bac6ff3c7f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_smbus.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_smbus.c @@ -172,6 +172,7 @@ */
/** @defgroup SMBUS SMBUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMBUS HAL module driver
* @{
*/
@@ -181,6 +182,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup SMBUS_Private_Define SMBUS Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIMING_CLEAR_MASK (0xF0FFFFFFUL) /*!< SMBUS TIMING clear register Mask */
@@ -222,10 +224,12 @@ static void SMBUS_TransferConfig(struct __SMBUS_HandleTypeDef *hsmbus, uint16_t /* Exported functions --------------------------------------------------------*/
/** @defgroup SMBUS_Exported_Functions SMBUS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SMBUS_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -858,6 +862,7 @@ HAL_StatusTypeDef HAL_SMBUS_UnRegisterAddrCallback(SMBUS_HandleTypeDef *hsmbus) */
/** @defgroup SMBUS_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -1549,6 +1554,7 @@ HAL_StatusTypeDef HAL_SMBUS_IsDeviceReady(SMBUS_HandleTypeDef *hsmbus, uint16_t */
/** @defgroup SMBUS_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1744,6 +1750,7 @@ __weak void HAL_SMBUS_ErrorCallback(SMBUS_HandleTypeDef *hsmbus) */
/** @defgroup SMBUS_Exported_Functions_Group3 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State and Errors functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spdifrx.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spdifrx.c index 2d27b27b15..ee70305525 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spdifrx.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spdifrx.c @@ -164,6 +164,7 @@ */
/** @defgroup SPDIFRX SPDIFRX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SPDIFRX HAL module driver
* @{
*/
@@ -195,10 +196,12 @@ static HAL_StatusTypeDef SPDIFRX_WaitOnFlagUntilTimeout(SPDIFRX_HandleTypeDef * /* Exported functions ---------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_Functions SPDIFRX Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPDIFRX_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -657,6 +660,7 @@ HAL_StatusTypeDef HAL_SPDIFRX_SetDataFormat(SPDIFRX_HandleTypeDef *hspdif, SPDIF */
/** @defgroup SPDIFRX_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -1374,6 +1378,7 @@ __weak void HAL_SPDIFRX_ErrorCallback(SPDIFRX_HandleTypeDef *hspdif) */
/** @defgroup SPDIFRX_Exported_Functions_Group3 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi.c index 0d3f32bca9..5c7f1e773a 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi.c @@ -135,6 +135,7 @@ */
/** @defgroup SPI SPI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SPI HAL module driver
* @{
*/
@@ -143,6 +144,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private defines -----------------------------------------------------------*/
/** @defgroup SPI_Private_Constants SPI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_DEFAULT_TIMEOUT 100UL
@@ -154,6 +156,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup SPI_Private_Functions SPI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void SPI_DMATransmitCplt(DMA_HandleTypeDef *hdma);
@@ -185,10 +188,12 @@ static uint32_t SPI_GetPacketSize(SPI_HandleTypeDef *hspi); /* Exported functions --------------------------------------------------------*/
/** @defgroup SPI_Exported_Functions SPI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPI_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -733,6 +738,7 @@ HAL_StatusTypeDef HAL_SPI_UnRegisterCallback(SPI_HandleTypeDef *hspi, HAL_SPI_Ca */
/** @defgroup SPI_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -3127,6 +3133,7 @@ __weak void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi) */
/** @defgroup SPI_Exported_Functions_Group3 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SPI control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi_ex.c index 5549d0b590..9299fb913c 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_spi_ex.c @@ -30,6 +30,7 @@ */
/** @defgroup SPIEx SPIEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SPI Extended HAL module driver
* @{
*/
@@ -43,10 +44,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup SPIEx_Exported_Functions SPIEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPIEx_Exported_Functions_Group1 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sram.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sram.c index 258e0838e7..7fb7c1873f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_sram.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_sram.c @@ -123,6 +123,7 @@ #ifdef HAL_SRAM_MODULE_ENABLED
/** @defgroup SRAM SRAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SRAM driver modules
* @{
*/
@@ -145,10 +146,12 @@ static void SRAM_DMAError (MDMA_HandleTypeDef *hmdma); /* Exported functions --------------------------------------------------------*/
/** @defgroup SRAM_Exported_Functions SRAM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SRAM_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions.
*
@verbatim
@@ -322,6 +325,7 @@ __weak void HAL_SRAM_DMA_XferErrorCallback(MDMA_HandleTypeDef *hmdma) */
/** @defgroup SRAM_Exported_Functions_Group2 Input Output and memory control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Input Output and memory control functions
*
@verbatim
@@ -907,6 +911,7 @@ HAL_StatusTypeDef HAL_SRAM_RegisterDmaCallback(SRAM_HandleTypeDef *hsram, HAL_SR */
/** @defgroup SRAM_Exported_Functions_Group3 Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Control functions
*
@verbatim
@@ -994,6 +999,7 @@ HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable(SRAM_HandleTypeDef *hsram) */
/** @defgroup SRAM_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_swpmi.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_swpmi.c index 18dace284e..30a7b27772 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_swpmi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_swpmi.c @@ -177,6 +177,7 @@ /** @defgroup SWPMI SWPMI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL SWPMI module driver
* @{
*/
@@ -214,10 +215,12 @@ static HAL_StatusTypeDef SWPMI_WaitOnFlagSetUntilTimeout(SWPMI_HandleTypeDef *hs /* Exported functions --------------------------------------------------------*/
/** @defgroup SWPMI_Exported_Functions SWPMI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SWPMI_Exported_Group1 Initialization/de-initialization methods
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -589,6 +592,7 @@ HAL_StatusTypeDef HAL_SWPMI_UnRegisterCallback(SWPMI_HandleTypeDef *hswpm */
/** @defgroup SWPMI_Exported_Group2 IO operation methods
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SWPMI Transmit/Receive functions
*
@verbatim
@@ -1270,6 +1274,7 @@ HAL_StatusTypeDef HAL_SWPMI_DisableLoopback(SWPMI_HandleTypeDef *hswpmi) */
/** @defgroup SWPMI_Exported_Group3 SWPMI IRQ handler and callbacks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SWPMI IRQ handler.
*
@verbatim
@@ -1535,6 +1540,7 @@ __weak void HAL_SWPMI_ErrorCallback(SWPMI_HandleTypeDef *hswpmi) */
/** @defgroup SWPMI_Exported_Group4 Peripheral Control methods
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SWPMI control functions
*
@verbatim
@@ -1582,6 +1588,7 @@ uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi) /* Private functions ---------------------------------------------------------*/
/** @defgroup SWPMI_Private_Functions SWPMI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim.c index 1885d04b39..78bc46cda9 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim.c @@ -191,6 +191,7 @@ all interrupt callbacks are set to the corresponding weak functions: */
/** @defgroup TIM TIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM HAL module driver
* @{
*/
@@ -231,10 +232,12 @@ static HAL_StatusTypeDef TIM_SlaveTimer_SetConfig(TIM_HandleTypeDef *htim, /* Exported functions --------------------------------------------------------*/
/** @defgroup TIM_Exported_Functions TIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIM_Exported_Functions_Group1 TIM Time Base functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Time Base functions
*
@verbatim
@@ -567,6 +570,7 @@ HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA(TIM_HandleTypeDef *htim) */
/** @defgroup TIM_Exported_Functions_Group2 TIM Output Compare functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Output Compare functions
*
@verbatim
@@ -1144,6 +1148,7 @@ HAL_StatusTypeDef HAL_TIM_OC_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel) */
/** @defgroup TIM_Exported_Functions_Group3 TIM PWM functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM PWM functions
*
@verbatim
@@ -1722,6 +1727,7 @@ HAL_StatusTypeDef HAL_TIM_PWM_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel */
/** @defgroup TIM_Exported_Functions_Group4 TIM Input Capture functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Input Capture functions
*
@verbatim
@@ -2257,6 +2263,7 @@ HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel) */
/** @defgroup TIM_Exported_Functions_Group5 TIM One Pulse functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM One Pulse functions
*
@verbatim
@@ -2571,6 +2578,7 @@ HAL_StatusTypeDef HAL_TIM_OnePulse_Stop_IT(TIM_HandleTypeDef *htim, uint32_t Out */
/** @defgroup TIM_Exported_Functions_Group6 TIM Encoder functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Encoder functions
*
@verbatim
@@ -3158,6 +3166,7 @@ HAL_StatusTypeDef HAL_TIM_Encoder_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Cha * @}
*/
/** @defgroup TIM_Exported_Functions_Group7 TIM IRQ handler management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM IRQ handler management
*
@verbatim
@@ -3372,6 +3381,7 @@ void HAL_TIM_IRQHandler(TIM_HandleTypeDef *htim) */
/** @defgroup TIM_Exported_Functions_Group8 TIM Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Peripheral Control functions
*
@verbatim
@@ -5056,6 +5066,7 @@ uint32_t HAL_TIM_ReadCapturedValue(TIM_HandleTypeDef *htim, uint32_t Channel) */
/** @defgroup TIM_Exported_Functions_Group9 TIM Callbacks functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Callbacks functions
*
@verbatim
@@ -5722,6 +5733,7 @@ HAL_StatusTypeDef HAL_TIM_UnRegisterCallback(TIM_HandleTypeDef *htim, HAL_TIM_Ca */
/** @defgroup TIM_Exported_Functions_Group10 TIM Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Peripheral State functions
*
@verbatim
@@ -5805,6 +5817,7 @@ HAL_TIM_StateTypeDef HAL_TIM_Encoder_GetState(TIM_HandleTypeDef *htim) */
/** @defgroup TIM_Private_Functions TIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim_ex.c index 1dcd77049c..843312be0f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_tim_ex.c @@ -83,6 +83,7 @@ */
/** @defgroup TIMEx TIMEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Extended HAL module driver
* @{
*/
@@ -98,10 +99,12 @@ static void TIM_CCxNChannelCmd(TIM_TypeDef *TIMx, uint32_t Channel, uint32_t Cha /* Exported functions --------------------------------------------------------*/
/** @defgroup TIMEx_Exported_Functions TIM Extended Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIMEx_Exported_Functions_Group1 Extended Timer Hall Sensor functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Timer Hall Sensor functions
*
@verbatim
@@ -476,6 +479,7 @@ HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA(TIM_HandleTypeDef *htim) */
/** @defgroup TIMEx_Exported_Functions_Group2 Extended Timer Complementary Output Compare functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Timer Complementary Output Compare functions
*
@verbatim
@@ -876,6 +880,7 @@ HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Chann */
/** @defgroup TIMEx_Exported_Functions_Group3 Extended Timer Complementary PWM functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Timer Complementary PWM functions
*
@verbatim
@@ -1283,6 +1288,7 @@ HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Chan */
/** @defgroup TIMEx_Exported_Functions_Group4 Extended Timer Complementary One Pulse functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Timer Complementary One Pulse functions
*
@verbatim
@@ -1424,6 +1430,7 @@ HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t */
/** @defgroup TIMEx_Exported_Functions_Group5 Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
*
@verbatim
@@ -2130,6 +2137,7 @@ HAL_StatusTypeDef HAL_TIMEx_GroupChannel5(TIM_HandleTypeDef *htim, uint32_t Chan */
/** @defgroup TIMEx_Exported_Functions_Group6 Extended Callbacks functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Callbacks functions
*
@verbatim
@@ -2208,6 +2216,7 @@ __weak void HAL_TIMEx_Break2Callback(TIM_HandleTypeDef *htim) */
/** @defgroup TIMEx_Exported_Functions_Group7 Extended Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral State functions
*
@verbatim
@@ -2242,6 +2251,7 @@ HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState(TIM_HandleTypeDef *htim) /* Private functions ---------------------------------------------------------*/
/** @defgroup TIMEx_Private_Functions TIMEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart.c index 02dfb77fc5..4310fbd664 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart.c @@ -161,6 +161,7 @@ */
/** @defgroup UART UART
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL UART module driver
* @{
*/
@@ -170,6 +171,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup UART_Private_Constants UART Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_CR1_FIELDS ((uint32_t)(USART_CR1_M | USART_CR1_PCE | USART_CR1_PS | \
@@ -223,10 +225,12 @@ static void UART_RxISR_16BIT_FIFOEN(UART_HandleTypeDef *huart); /* Exported functions --------------------------------------------------------*/
/** @defgroup UART_Exported_Functions UART Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -939,6 +943,7 @@ HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UAR */
/** @defgroup UART_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART Transmit/Receive functions
*
@verbatim
@@ -2528,6 +2533,7 @@ __weak void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart) */
/** @defgroup UART_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART control functions
*
@verbatim
@@ -2772,6 +2778,7 @@ HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart) */
/** @defgroup UART_Exported_Functions_Group4 Peripheral State and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART Peripheral State functions
*
@verbatim
@@ -2822,6 +2829,7 @@ uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart) */
/** @defgroup UART_Private_Functions UART Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart_ex.c index 949208523e..362afcc78b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_uart_ex.c @@ -48,6 +48,7 @@ */
/** @defgroup UARTEx UARTEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART Extended HAL module driver
* @{
*/
@@ -57,6 +58,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup UARTEX_Private_Constants UARTEx Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* UART RX FIFO depth */
@@ -72,6 +74,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup UARTEx_Private_Functions UARTEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void UARTEx_Wakeup_AddressConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection);
@@ -83,10 +86,12 @@ static void UARTEx_SetNbDataToProcess(UART_HandleTypeDef *huart); /* Exported functions --------------------------------------------------------*/
/** @defgroup UARTEx_Exported_Functions UARTEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UARTEx_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Initialization and Configuration Functions
*
@verbatim
@@ -245,6 +250,7 @@ HAL_StatusTypeDef HAL_RS485Ex_Init(UART_HandleTypeDef *huart, uint32_t Polarity, */
/** @defgroup UARTEx_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended functions
*
@verbatim
@@ -314,6 +320,7 @@ __weak void HAL_UARTEx_TxFifoEmptyCallback(UART_HandleTypeDef *huart) */
/** @defgroup UARTEx_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral Control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart.c index ce0f2d2ac1..20cd7dc336 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart.c @@ -143,6 +143,7 @@ */
/** @defgroup USART USART
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL USART Synchronous module driver
* @{
*/
@@ -152,6 +153,7 @@ /* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup USART_Private_Constants USART Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_DUMMY_DATA ((uint16_t) 0xFFFF) /*!< USART transmitted dummy data */
@@ -212,10 +214,12 @@ static void USART_RxISR_16BIT_FIFOEN(USART_HandleTypeDef *husart); /* Exported functions --------------------------------------------------------*/
/** @defgroup USART_Exported_Functions USART Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USART_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -659,6 +663,7 @@ HAL_StatusTypeDef HAL_USART_UnRegisterCallback(USART_HandleTypeDef *husart, HAL_ */
/** @defgroup USART_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART Transmit and Receive functions
*
@verbatim
@@ -2427,6 +2432,7 @@ __weak void HAL_USART_AbortCpltCallback(USART_HandleTypeDef *husart) */
/** @defgroup USART_Exported_Functions_Group4 Peripheral State and Error functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART Peripheral State and Error functions
*
@verbatim
@@ -2474,6 +2480,7 @@ uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart) */
/** @defgroup USART_Private_Functions USART Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart_ex.c index 2732976f47..3d618e90ad 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_usart_ex.c @@ -47,6 +47,7 @@ */
/** @defgroup USARTEx USARTEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART Extended HAL module driver
* @{
*/
@@ -55,6 +56,7 @@ /* Private typedef -----------------------------------------------------------*/
/** @defgroup USARTEx_Private_Constants USARTEx Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* USART RX FIFO depth */
@@ -71,6 +73,7 @@ /* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup USARTEx_Private_Functions USARTEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static void USARTEx_SetNbDataToProcess(USART_HandleTypeDef *husart);
@@ -81,10 +84,12 @@ static void USARTEx_SetNbDataToProcess(USART_HandleTypeDef *husart); /* Exported functions --------------------------------------------------------*/
/** @defgroup USARTEx_Exported_Functions USARTEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USARTEx_Exported_Functions_Group1 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended USART Transmit/Receive functions
*
@verbatim
@@ -136,6 +141,7 @@ __weak void HAL_USARTEx_TxFifoEmptyCallback(USART_HandleTypeDef *husart) */
/** @defgroup USARTEx_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended Peripheral Control functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_wwdg.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_wwdg.c index a4e29c5e0e..85da9c319f 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_wwdg.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_wwdg.c @@ -127,6 +127,7 @@ #ifdef HAL_WWDG_MODULE_ENABLED
/** @defgroup WWDG WWDG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief WWDG HAL module driver.
* @{
*/
@@ -139,10 +140,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup WWDG_Exported_Functions WWDG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup WWDG_Exported_Functions_Group1 Initialization and Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions.
*
@verbatim
@@ -311,6 +314,7 @@ HAL_StatusTypeDef HAL_WWDG_UnRegisterCallback(WWDG_HandleTypeDef *hwwdg, HAL_WWD */
/** @defgroup WWDG_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_crs.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_crs.c index 7b02c2e4db..990007183b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_crs.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_crs.c @@ -29,6 +29,7 @@ #if defined(CRS)
/** @defgroup CRS_LL CRS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_delayblock.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_delayblock.c index 54d8863d73..2c1f9696c3 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_delayblock.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_delayblock.c @@ -56,6 +56,7 @@ */
/** @defgroup DELAYBLOCK_LL DELAYBLOCK_LL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Low layer module for Delay Block
* @{
*/
@@ -71,10 +72,12 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup DelayBlock_LL_Exported_Functions Delay Block Low Layer Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HAL_DELAY_LL_Group1 Initialization de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_exti.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_exti.c index 872ab12ffc..85e765e53d 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_exti.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_exti.c @@ -33,6 +33,7 @@ #if defined (EXTI)
/** @defgroup EXTI_LL EXTI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_fmc.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_fmc.c index 7625f212bd..8761b0df8d 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_fmc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_fmc.c @@ -63,6 +63,7 @@ #if (((defined HAL_NOR_MODULE_ENABLED || defined HAL_SRAM_MODULE_ENABLED)) || defined HAL_NAND_MODULE_ENABLED || defined HAL_SDRAM_MODULE_ENABLED)
/** @defgroup FMC_LL FMC Low Layer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FMC driver modules
* @{
*/
@@ -71,6 +72,7 @@ /* Private define ------------------------------------------------------------*/
/** @defgroup FMC_LL_Private_Constants FMC Low Layer Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -139,11 +141,13 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup FMC_LL_Exported_Functions FMC Low Layer Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_LL_Exported_Functions_NORSRAM FMC Low Layer NOR SRAM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief NORSRAM Controller functions
*
@verbatim
@@ -168,6 +172,7 @@ */
/** @defgroup FMC_LL_NORSRAM_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -472,6 +477,7 @@ HAL_StatusTypeDef FMC_NORSRAM_WriteOperation_Disable(FMC_NORSRAM_TypeDef *Device /** @defgroup FMC_LL_Exported_Functions_NAND FMC Low Layer NAND Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief NAND Controller functions
*
@verbatim
@@ -497,6 +503,7 @@ HAL_StatusTypeDef FMC_NORSRAM_WriteOperation_Disable(FMC_NORSRAM_TypeDef *Device */
/** @defgroup FMC_LL_NAND_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -637,6 +644,7 @@ HAL_StatusTypeDef FMC_NAND_DeInit(FMC_NAND_TypeDef *Device, uint32_t Bank) */
/** @defgroup HAL_FMC_NAND_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -743,6 +751,7 @@ HAL_StatusTypeDef FMC_NAND_GetECC(FMC_NAND_TypeDef *Device, uint32_t *ECCval, ui /** @defgroup FMC_LL_SDRAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SDRAM Controller functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_i2c.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_i2c.c index c99a1cff28..119aa3586b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_i2c.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_i2c.c @@ -34,6 +34,7 @@ #if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4)
/** @defgroup I2C_LL I2C
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_lptim.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_lptim.c index 3b1359369b..bc9e0f5539 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_lptim.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_lptim.c @@ -72,6 +72,7 @@ /* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
/** @defgroup LPTIM_Private_Functions LPTIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_mdma.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_mdma.c index 940c470ed9..fff232f923 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_mdma.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_mdma.c @@ -34,6 +34,7 @@ #if defined (MDMA)
/** @defgroup MDMA_LL MDMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_pwr.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_pwr.c index 194f52e339..719c18ef6c 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_pwr.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_pwr.c @@ -29,6 +29,7 @@ #if defined (PWR)
/** @defgroup PWR_LL PWR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_rcc.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_rcc.c index 120d5a20ab..2b308a9bf4 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_rcc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_rcc.c @@ -77,6 +77,7 @@ const uint8_t LL_RCC_PrescTable[16] = {0, 0, 0, 0, 1, 2, 3, 4, 1, 2, 3, 4, 6, 7, /* Private function prototypes -----------------------------------------------*/
/** @defgroup RCC_LL_Private_Functions RCC Private functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
uint32_t RCC_GetSystemClockFreq(void);
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_sdmmc.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_sdmmc.c index e97363a1b4..862db37906 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_sdmmc.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_sdmmc.c @@ -158,6 +158,7 @@ */
/** @defgroup SDMMC_LL SDMMC Low Layer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Low layer module for SD
* @{
*/
@@ -179,10 +180,12 @@ static uint32_t SDMMC_GetCmdResp6(SDMMC_TypeDef *SDMMCx, uint8_t SD_CMD, uint16_ /* Exported functions --------------------------------------------------------*/
/** @defgroup SDMMC_LL_Exported_Functions SDMMC Low Layer Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HAL_SDMMC_LL_Group1 Initialization de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
@@ -234,6 +237,7 @@ HAL_StatusTypeDef SDMMC_Init(SDMMC_TypeDef *SDMMCx, SDMMC_InitTypeDef Init) */
/** @defgroup HAL_SDMMC_LL_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
@@ -278,6 +282,7 @@ HAL_StatusTypeDef SDMMC_WriteFIFO(SDMMC_TypeDef *SDMMCx, uint32_t *pWriteData) */
/** @defgroup HAL_SDMMC_LL_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief management functions
*
@verbatim
@@ -497,6 +502,7 @@ HAL_StatusTypeDef SDMMC_SetSDMMCReadWaitMode(SDMMC_TypeDef *SDMMCx, uint32_t SDM /** @defgroup HAL_SDMMC_LL_Group4 Command management functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Data transfers functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_spi.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_spi.c index 4e3158a06a..88130ce96b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_spi.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_spi.c @@ -453,6 +453,7 @@ void LL_SPI_StructInit(LL_SPI_InitTypeDef *SPI_InitStruct) /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup I2S_LL_Private_Constants I2S Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* I2S registers Masks */
@@ -466,6 +467,7 @@ void LL_SPI_StructInit(LL_SPI_InitTypeDef *SPI_InitStruct) */
/* Private macros ------------------------------------------------------------*/
/** @defgroup I2S_LL_Private_Macros I2S Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_tim.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_tim.c index 8e411aae12..e4a5399244 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_tim.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_tim.c @@ -182,6 +182,7 @@ /* Private function prototypes -----------------------------------------------*/
/** @defgroup TIM_LL_Private_Functions TIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static ErrorStatus OC1Config(TIM_TypeDef *TIMx, LL_TIM_OC_InitTypeDef *TIM_OCInitStruct);
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_usb.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_usb.c index 1e4ae32fd1..f74fc04049 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_usb.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_usb.c @@ -57,10 +57,12 @@ static HAL_StatusTypeDef USB_CoreReset(USB_OTG_GlobalTypeDef *USBx); /* Exported functions --------------------------------------------------------*/
/** @defgroup USB_LL_Exported_Functions USB Low Layer Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USB_LL_Exported_Functions_Group1 Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions
*
@verbatim
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_ll_utils.c b/bsps/arm/stm32h7/hal/stm32h7xx_ll_utils.c index cf19f61708..936fe89b29 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_ll_utils.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_ll_utils.c @@ -221,6 +221,7 @@ */
/* Private function prototypes -----------------------------------------------*/
/** @defgroup UTILS_LL_Private_Functions UTILS Private functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static uint32_t UTILS_GetPLLOutputFrequency(uint32_t PLL_InputFrequency, LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct);
diff --git a/bsps/arm/stm32h7/include/Legacy/stm32_hal_legacy.h b/bsps/arm/stm32h7/include/Legacy/stm32_hal_legacy.h index 7b859e3782..c311c1618e 100644 --- a/bsps/arm/stm32h7/include/Legacy/stm32_hal_legacy.h +++ b/bsps/arm/stm32h7/include/Legacy/stm32_hal_legacy.h @@ -31,6 +31,7 @@ /* Exported constants --------------------------------------------------------*/
/** @defgroup HAL_AES_Aliased_Defines HAL CRYP Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define AES_FLAG_RDERR CRYP_FLAG_RDERR
@@ -44,6 +45,7 @@ */
/** @defgroup HAL_ADC_Aliased_Defines HAL ADC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_RESOLUTION12b ADC_RESOLUTION_12B
@@ -103,6 +105,7 @@ */
/** @defgroup HAL_CEC_Aliased_Defines HAL CEC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -113,6 +116,7 @@ */
/** @defgroup HAL_COMP_Aliased_Defines HAL COMP Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_WINDOWMODE_DISABLED COMP_WINDOWMODE_DISABLE
@@ -204,6 +208,7 @@ */
/** @defgroup HAL_CORTEX_Aliased_Defines HAL CORTEX Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_CORTEX_SYSTICKCLK_CONFIG HAL_SYSTICK_CLKSourceConfig
@@ -212,6 +217,7 @@ */
/** @defgroup HAL_CRC_Aliased_Defines HAL CRC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -223,6 +229,7 @@ */
/** @defgroup HAL_DAC_Aliased_Defines HAL DAC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -251,6 +258,7 @@ */
/** @defgroup HAL_DMA_Aliased_Defines HAL DMA Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_REMAPDMA_ADC_DMA_CH2 DMA_REMAP_ADC_DMA_CH2
@@ -384,6 +392,7 @@ */
/** @defgroup HAL_FLASH_Aliased_Defines HAL FLASH Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -481,6 +490,7 @@ */
/** @defgroup HAL_JPEG_Aliased_Macros HAL JPEG Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -498,6 +508,7 @@ */
/** @defgroup HAL_SYSCFG_Aliased_Defines HAL SYSCFG Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -523,6 +534,7 @@ /** @defgroup LL_FMC_Aliased_Defines LL FMC Aliased Defines maintained for compatibility purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(STM32L4) || defined(STM32F7) || defined(STM32H7) || defined(STM32G4)
@@ -541,6 +553,7 @@ */
/** @defgroup LL_FSMC_Aliased_Defines LL FSMC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -551,6 +564,7 @@ */
/** @defgroup HAL_GPIO_Aliased_Macros HAL GPIO Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GET_GPIO_SOURCE GPIO_GET_INDEX
@@ -617,6 +631,7 @@ */
/** @defgroup HAL_HRTIM_Aliased_Macros HAL HRTIM Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_TIMDELAYEDPROTECTION_DISABLED HRTIM_TIMER_A_B_C_DELAYEDPROTECTION_DISABLED
@@ -821,6 +836,7 @@ */
/** @defgroup HAL_I2C_Aliased_Defines HAL I2C Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_DUALADDRESS_DISABLED I2C_DUALADDRESS_DISABLE
@@ -844,6 +860,7 @@ */
/** @defgroup HAL_IRDA_Aliased_Defines HAL IRDA Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_ONE_BIT_SAMPLE_DISABLED IRDA_ONE_BIT_SAMPLE_DISABLE
@@ -854,6 +871,7 @@ */
/** @defgroup HAL_IWDG_Aliased_Defines HAL IWDG Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define KR_KEY_RELOAD IWDG_KEY_RELOAD
@@ -865,6 +883,7 @@ */
/** @defgroup HAL_LPTIM_Aliased_Defines HAL LPTIM Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -893,6 +912,7 @@ */
/** @defgroup HAL_NAND_Aliased_Defines HAL NAND Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_NAND_Read_Page HAL_NAND_Read_Page_8b
@@ -912,6 +932,7 @@ */
/** @defgroup HAL_NOR_Aliased_Defines HAL NOR Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define NOR_StatusTypedef HAL_NOR_StatusTypeDef
@@ -927,6 +948,7 @@ */
/** @defgroup HAL_OPAMP_Aliased_Defines HAL OPAMP Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -966,6 +988,7 @@ */
/** @defgroup HAL_I2S_Aliased_Defines HAL I2S Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_STANDARD_PHILLIPS I2S_STANDARD_PHILIPS
@@ -986,6 +1009,7 @@ */
/** @defgroup HAL_PCCARD_Aliased_Defines HAL PCCARD Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1016,6 +1040,7 @@ */
/** @defgroup HAL_RTC_Aliased_Defines HAL RTC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1062,6 +1087,7 @@ /** @defgroup HAL_SMARTCARD_Aliased_Defines HAL SMARTCARD Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_NACK_ENABLED SMARTCARD_NACK_ENABLE
@@ -1083,6 +1109,7 @@ /** @defgroup HAL_SMBUS_Aliased_Defines HAL SMBUS Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMBUS_DUALADDRESS_DISABLED SMBUS_DUALADDRESS_DISABLE
@@ -1101,6 +1128,7 @@ */
/** @defgroup HAL_SPI_Aliased_Defines HAL SPI Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_TIMODE_DISABLED SPI_TIMODE_DISABLE
@@ -1132,6 +1160,7 @@ */
/** @defgroup HAL_TIM_Aliased_Defines HAL TIM Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CCER_CCxE_MASK TIM_CCER_CCxE_MASK
@@ -1226,6 +1255,7 @@ */
/** @defgroup HAL_TSC_Aliased_Defines HAL TSC Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TSC_SYNC_POL_FALL TSC_SYNC_POLARITY_FALLING
@@ -1235,6 +1265,7 @@ */
/** @defgroup HAL_UART_Aliased_Defines HAL UART Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ONEBIT_SAMPLING_DISABLED UART_ONE_BIT_SAMPLE_DISABLE
@@ -1266,6 +1297,7 @@ /** @defgroup HAL_USART_Aliased_Defines HAL USART Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1279,6 +1311,7 @@ */
/** @defgroup HAL_WWDG_Aliased_Defines HAL WWDG Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CFR_BASE WWDG_CFR_BASE
@@ -1288,6 +1321,7 @@ */
/** @defgroup HAL_CAN_Aliased_Defines HAL CAN Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CAN_FilterFIFO0 CAN_FILTER_FIFO0
@@ -1306,6 +1340,7 @@ */
/** @defgroup HAL_ETH_Aliased_Defines HAL ETH Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1366,6 +1401,7 @@ */
/** @defgroup HAL_DCMI_Aliased_Defines HAL DCMI Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DCMI_ERROR_OVF HAL_DCMI_ERROR_OVR
@@ -1385,6 +1421,7 @@ || defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F469xx) || defined(STM32F479xx) \
|| defined(STM32H7)
/** @defgroup HAL_DMA2D_Aliased_Defines HAL DMA2D Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_ARGB8888 DMA2D_OUTPUT_ARGB8888
@@ -1410,6 +1447,7 @@ #endif /* STM32L4 || STM32F7 || STM32F4 || STM32H7 */
/** @defgroup HAL_PPP_Aliased_Defines HAL PPP Aliased Defines maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1420,6 +1458,7 @@ /* Exported functions --------------------------------------------------------*/
/** @defgroup HAL_CRYP_Aliased_Functions HAL CRYP Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRYP_ComputationCpltCallback HAL_CRYPEx_ComputationCpltCallback
@@ -1428,6 +1467,7 @@ */
/** @defgroup HAL_HASH_Aliased_Functions HAL HASH Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_HASH_STATETypeDef HAL_HASH_StateTypeDef
@@ -1478,6 +1518,7 @@ */
/** @defgroup HAL_Aliased_Functions HAL Generic Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_EnableDBGSleepMode HAL_DBGMCU_EnableDBGSleepMode
@@ -1507,6 +1548,7 @@ */
/** @defgroup HAL_FLASH_Aliased_Functions HAL FLASH Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_HalfPageProgram HAL_FLASHEx_HalfPageProgram
@@ -1522,6 +1564,7 @@ */
/** @defgroup HAL_I2C_Aliased_Functions HAL I2C Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_I2CEx_AnalogFilter_Config HAL_I2CEx_ConfigAnalogFilter
@@ -1559,6 +1602,7 @@ */
/** @defgroup HAL_PWR_Aliased HAL PWR Aliased maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1616,6 +1660,7 @@ */
/** @defgroup HAL_SMBUS_Aliased_Functions HAL SMBUS Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SMBUS_Slave_Listen_IT HAL_SMBUS_EnableListen_IT
@@ -1626,6 +1671,7 @@ */
/** @defgroup HAL_SPI_Aliased_Functions HAL SPI Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SPI_FlushRxFifo HAL_SPIEx_FlushRxFifo
@@ -1634,6 +1680,7 @@ */
/** @defgroup HAL_TIM_Aliased_Functions HAL TIM Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_TIM_DMADelayPulseCplt TIM_DMADelayPulseCplt
@@ -1653,6 +1700,7 @@ */
/** @defgroup HAL_UART_Aliased_Functions HAL UART Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_UART_WakeupCallback HAL_UARTEx_WakeupCallback
@@ -1661,6 +1709,7 @@ */
/** @defgroup HAL_LTDC_Aliased_Functions HAL LTDC Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_LTDC_LineEvenCallback HAL_LTDC_LineEventCallback
@@ -1673,6 +1722,7 @@ /** @defgroup HAL_PPP_Aliased_Functions HAL PPP Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1683,6 +1733,7 @@ /* Exported macros ------------------------------------------------------------*/
/** @defgroup HAL_AES_Aliased_Macros HAL CRYP Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define AES_IT_CC CRYP_IT_CC
@@ -1693,6 +1744,7 @@ */
/** @defgroup HAL_Aliased_Macros HAL Generic Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_GET_BOOT_MODE __HAL_SYSCFG_GET_BOOT_MODE
@@ -1722,6 +1774,7 @@ /** @defgroup HAL_ADC_Aliased_Macros HAL ADC Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __ADC_ENABLE __HAL_ADC_ENABLE
@@ -1806,6 +1859,7 @@ */
/** @defgroup HAL_DAC_Aliased_Macros HAL DAC Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_DHR12R1_ALIGNEMENT DAC_DHR12R1_ALIGNMENT
@@ -1818,6 +1872,7 @@ */
/** @defgroup HAL_DBGMCU_Aliased_Macros HAL DBGMCU Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_FREEZE_TIM1_DBGMCU __HAL_DBGMCU_FREEZE_TIM1
@@ -1890,6 +1945,7 @@ */
/** @defgroup HAL_COMP_Aliased_Macros HAL COMP Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(STM32F3)
@@ -2067,6 +2123,7 @@ #if defined(STM32L0) || defined(STM32L4)
/** @defgroup HAL_COMP_Aliased_Functions HAL COMP Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_COMP_Start_IT HAL_COMP_Start /* Function considered as legacy as EXTI event or IT configuration is done into HAL_COMP_Init() */
@@ -2077,6 +2134,7 @@ #endif
/** @defgroup HAL_DAC_Aliased_Macros HAL DAC Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2089,6 +2147,7 @@ */
/** @defgroup HAL_FLASH_Aliased_Macros HAL FLASH Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2104,6 +2163,7 @@ */
/** @defgroup HAL_I2C_Aliased_Macros HAL I2C Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2131,6 +2191,7 @@ */
/** @defgroup HAL_I2S_Aliased_Macros HAL I2S Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2146,6 +2207,7 @@ */
/** @defgroup HAL_IRDA_Aliased_Macros HAL IRDA Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2166,6 +2228,7 @@ /** @defgroup HAL_IWDG_Aliased_Macros HAL IWDG Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_IWDG_ENABLE_WRITE_ACCESS IWDG_ENABLE_WRITE_ACCESS
@@ -2176,6 +2239,7 @@ /** @defgroup HAL_LPTIM_Aliased_Macros HAL LPTIM Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2189,6 +2253,7 @@ /** @defgroup HAL_OPAMP_Aliased_Macros HAL OPAMP Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __OPAMP_CSR_OPAXPD OPAMP_CSR_OPAXPD
@@ -2211,6 +2276,7 @@ /** @defgroup HAL_PWR_Aliased_Macros HAL PWR Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_PVD_EVENT_DISABLE __HAL_PWR_PVD_EXTI_DISABLE_EVENT
@@ -2268,6 +2334,7 @@ /** @defgroup HAL_RCC_Aliased HAL RCC Aliased maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3361,6 +3428,7 @@ */
/** @defgroup HAL_RNG_Aliased_Macros HAL RNG Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_RNG_ReadyCallback(__HANDLE__) HAL_RNG_ReadyDataCallback((__HANDLE__), uint32_t random32bit)
@@ -3370,6 +3438,7 @@ */
/** @defgroup HAL_RTC_Aliased_Macros HAL RTC Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (STM32G0) || defined (STM32L5) || defined (STM32L412xx) || defined (STM32L422xx) || defined (STM32L4P5xx) || defined (STM32L4Q5xx) || defined (STM32G4)
@@ -3430,6 +3499,7 @@ */
/** @defgroup HAL_SD_Aliased_Macros HAL SD Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3511,6 +3581,7 @@ */
/** @defgroup HAL_SMARTCARD_Aliased_Macros HAL SMARTCARD Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3531,6 +3602,7 @@ */
/** @defgroup HAL_SMBUS_Aliased_Macros HAL SMBUS Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_SMBUS_RESET_CR1 SMBUS_RESET_CR1
@@ -3546,6 +3618,7 @@ */
/** @defgroup HAL_SPI_Aliased_Macros HAL SPI Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3558,6 +3631,7 @@ */
/** @defgroup HAL_UART_Aliased_Macros HAL UART Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3577,6 +3651,7 @@ /** @defgroup HAL_USART_Aliased_Macros HAL USART Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3593,6 +3668,7 @@ */
/** @defgroup HAL_USB_Aliased_Macros HAL USB Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_EXTI_LINE_WAKEUP USB_WAKEUP_EXTI_LINE
@@ -3643,6 +3719,7 @@ */
/** @defgroup HAL_TIM_Aliased_Macros HAL TIM Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_TIM_SetICPrescalerValue TIM_SET_ICPRESCALERVALUE
@@ -3672,6 +3749,7 @@ */
/** @defgroup HAL_ETH_Aliased_Macros HAL ETH Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3691,6 +3769,7 @@ */
/** @defgroup HAL_LTDC_Aliased_Macros HAL LTDC Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define __HAL_LTDC_LAYER LTDC_LAYER
@@ -3700,6 +3779,7 @@ */
/** @defgroup HAL_SAI_Aliased_Macros HAL SAI Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_OUTPUTDRIVE_DISABLED SAI_OUTPUTDRIVE_DISABLE
@@ -3721,6 +3801,7 @@ */
/** @defgroup HAL_SPDIFRX_Aliased_Macros HAL SPDIFRX Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(STM32H7)
@@ -3733,6 +3814,7 @@ */
/** @defgroup HAL_HRTIM_Aliased_Functions HAL HRTIM Aliased Functions maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (STM32H7) || defined (STM32G4) || defined (STM32F3)
@@ -3748,6 +3830,7 @@ */
/** @defgroup HAL_QSPI_Aliased_Macros HAL QSPI Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (STM32L4) || defined (STM32F4) || defined (STM32F7) || defined(STM32H7)
@@ -3758,6 +3841,7 @@ */
/** @defgroup HAL_PPP_Aliased_Macros HAL PPP Aliased Macros maintained for legacy purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/bsp.h b/bsps/arm/stm32h7/include/bsp.h index 06c4e678aa..0ed9c361a5 100644 --- a/bsps/arm/stm32h7/include/bsp.h +++ b/bsps/arm/stm32h7/include/bsp.h @@ -37,6 +37,16 @@ extern "C" { #endif +/** + * @defgroup RTEMSBSPsARMSTM32H7 STM32H7 + * + * @ingroup RTEMSBSPsARM + * + * @brief STM32H7 Board Support Package. + * + * @{ + */ + #define BSP_FEATURE_IRQ_EXTENSION #define BSP_ARMV7M_IRQ_PRIORITY_DEFAULT (13 << 4) @@ -47,6 +57,8 @@ extern "C" { uint32_t stm32h7_systick_frequency(void); +/** @} */ + #ifdef __cplusplus } #endif diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal.h b/bsps/arm/stm32h7/include/stm32h7xx_hal.h index 2ee957c352..9ca9d4db1f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup HAL_TICK_FREQ Tick Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -55,6 +56,7 @@ typedef enum /* Exported constants --------------------------------------------------------*/
/** @defgroup REV_ID device revision ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define REV_ID_Y ((uint32_t)0x1003) /*!< STM32H7 rev.Y */
@@ -67,6 +69,7 @@ typedef enum */
/** @defgroup SYSCFG_VREFBUF_VoltageScale VREFBUF Voltage Scale
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_VREFBUF_VOLTAGE_SCALE0 VREFBUF_CSR_VRS_OUT2 /*!< Voltage reference scale 0 (VREF_OUT2) */
@@ -86,6 +89,7 @@ typedef enum */
/** @defgroup SYSCFG_VREFBUF_HighImpedance VREFBUF High Impedance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_VREFBUF_HIGH_IMPEDANCE_DISABLE ((uint32_t)0x00000000) /*!< VREF_plus pin is internally connected to Voltage reference buffer output */
@@ -102,6 +106,7 @@ typedef enum #if !defined(SYSCFG_PMCR_BOOSTEN)
/** @defgroup SYSCFG_FastModePlus_GPIO Fast-mode Plus on GPIO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -123,6 +128,7 @@ typedef enum */
/** @defgroup SYSCFG_Ethernet_Config Ethernet Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_ETH_MII ((uint32_t)0x00000000) /*!< Select the Media Independent Interface */
@@ -137,6 +143,7 @@ typedef enum /** @defgroup SYSCFG_Analog_Switch_Config Analog Switch Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_SWITCH_PA0 SYSCFG_PMCR_PA0SO /*!< Select PA0 analog switch */
@@ -173,6 +180,7 @@ typedef enum */
/** @defgroup SYSCFG_Boot_Config Boot Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_BOOT_ADDR0 ((uint32_t)0x00000000) /*!< Select Boot address0 */
@@ -189,6 +197,7 @@ typedef enum /** @defgroup SYSCFG_IOCompenstionCell_Config IOCompenstionCell Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSCFG_CELL_CODE ((uint32_t)0x00000000) /*!< Select Code from the cell */
@@ -207,6 +216,7 @@ typedef enum /** @defgroup EXTI_Event_Input_Config Event Input Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -652,6 +662,7 @@ typedef enum /** @defgroup FMC_SwapBankMapping_Config SwapBankMapping Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SWAPBMAP_DISABLE (0x00000000U)
@@ -668,6 +679,7 @@ typedef enum /* Exported macro ------------------------------------------------------------*/
/** @defgroup ART_Exported_Macros ART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(DUAL_CORE)
@@ -693,6 +705,7 @@ typedef enum */
/** @defgroup SYSCFG_Exported_Macros SYSCFG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -950,6 +963,7 @@ typedef enum #endif /*DUAL_CORE*/
/** @defgroup HAL_Private_Macros HAL Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_TICKFREQ(FREQ) (((FREQ) == HAL_TICK_FREQ_10HZ) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h index 0752dc9ffa..2f04c196fb 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h @@ -41,6 +41,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup ADC_Exported_Types ADC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -307,6 +308,7 @@ typedef struct } ADC_InjectionConfigTypeDef;
/** @defgroup ADC_States ADC States
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -419,10 +421,12 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup ADC_Exported_Constants ADC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_Error_Code ADC Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_ADC_ERROR_NONE (0x00U) /*!< No error */
@@ -439,6 +443,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_COMMON_CLOCK_SOURCE ADC common - Clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_CLOCK_SYNC_PCLK_DIV1 (LL_ADC_CLOCK_SYNC_PCLK_DIV1) /*!< ADC synchronous clock derived from AHB clock without prescaler */
@@ -462,6 +467,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_RESOLUTION ADC instance - Resolution
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_RESOLUTION_16B (LL_ADC_RESOLUTION_16B) /*!< ADC resolution 16 bits */
@@ -474,6 +480,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_Scan_mode ADC sequencer scan mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_SCAN_DISABLE (0x00000000UL) /*!< Scan mode disabled */
@@ -483,6 +490,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_regular_external_trigger_source ADC group regular trigger source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* ADC group regular trigger sources for all ADC instances */
@@ -513,6 +521,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_regular_external_trigger_edge ADC group regular trigger edge (when external trigger is selected)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_EXTERNALTRIGCONVEDGE_NONE (0x00000000UL) /*!< Regular conversions hardware trigger detection disabled */
@@ -524,6 +533,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_EOCSelection ADC sequencer end of unitary conversion or sequence conversions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_EOC_SINGLE_CONV (ADC_ISR_EOC) /*!< End of unitary conversion flag */
@@ -533,6 +543,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_REG_OVR_DATA_BEHAVIOR ADC group regular - Overrun behavior on conversion data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_OVR_DATA_PRESERVED (LL_ADC_REG_OVR_DATA_PRESERVED) /*!< ADC group regular behavior in case of overrun: data preserved */
@@ -542,6 +553,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_REG_SEQ_RANKS ADC group regular - Sequencer ranks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_REGULAR_RANK_1 (LL_ADC_REG_RANK_1) /*!< ADC group regular sequencer rank 1 */
@@ -565,6 +577,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_CHANNEL_SAMPLINGTIME Channel - Sampling time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_SAMPLETIME_1CYCLE_5 (LL_ADC_SAMPLINGTIME_1CYCLE_5) /*!< Sampling time 1.5 ADC clock cycles */
@@ -580,6 +593,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADCEx_Calibration_Mode ADC Extended Calibration mode offset mode or linear mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_CALIB_OFFSET (LL_ADC_CALIB_OFFSET)
@@ -589,6 +603,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_CHANNEL ADC instance - Channel number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Note: VrefInt, TempSensor and Vbat internal channels are not available on */
@@ -626,6 +641,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_ConversionDataManagement ADC Conversion Data Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_CONVERSIONDATA_DR (0x00000000UL) /*!< Regular Conversion data stored in DR register only */
@@ -636,6 +652,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to * @}
*/
/** @defgroup ADC_HAL_EC_AWD_NUMBER Analog watchdog - Analog watchdog number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_ANALOGWATCHDOG_1 (LL_ADC_AWD1) /*!< ADC analog watchdog number 1 */
@@ -646,6 +663,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_analog_watchdog_mode ADC Analog Watchdog Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_ANALOGWATCHDOG_NONE (0x00000000UL) /*!< No analog watchdog selected */
@@ -660,6 +678,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_OVS_SHIFT Oversampling - Data shift
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_RIGHTBITSHIFT_NONE (LL_ADC_OVS_SHIFT_NONE) /*!< ADC oversampling no shift (sum of the ADC conversions data is not divided to result as the ADC oversampling conversion data) */
@@ -679,6 +698,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADCEx_Left_Bit_Shift ADC Extended Oversampling left Shift
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_LEFTBITSHIFT_NONE (LL_ADC_LEFT_BIT_SHIFT_NONE) /*!< ADC No bit shift */
@@ -702,6 +722,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_OVS_DISCONT_MODE Oversampling - Discontinuous mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_TRIGGEREDMODE_SINGLE_TRIGGER (LL_ADC_OVS_REG_CONT) /*!< ADC oversampling discontinuous mode: continuous mode (all conversions of oversampling ratio are done from 1 trigger) */
@@ -711,6 +732,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EC_OVS_SCOPE_REG Oversampling - Oversampling scope for ADC group regular
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_REGOVERSAMPLING_CONTINUED_MODE (LL_ADC_OVS_GRP_REGULAR_CONTINUED) /*!< Oversampling buffer maintained during injection sequence */
@@ -721,6 +743,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to /** @defgroup ADC_Event_type ADC Event type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_EOSMP_EVENT (ADC_FLAG_EOSMP) /*!< ADC End of Sampling event */
@@ -735,6 +758,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to #define ADC_AWD_EVENT ADC_AWD1_EVENT /*!< ADC Analog watchdog 1 event: Naming for compatibility with other STM32 devices having only one analog watchdog */
/** @defgroup ADC_interrupts_definition ADC interrupts definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_IT_RDY ADC_IER_ADRDYIE /*!< ADC Ready interrupt source */
@@ -756,6 +780,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_flags_definition ADC flags definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_FLAG_RDY ADC_ISR_ADRDY /*!< ADC Ready flag */
@@ -781,6 +806,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to /* Private macro -------------------------------------------------------------*/
/** @defgroup ADC_Private_Macros ADC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Macro reserved for internal HAL driver usage, not intended to be used in */
@@ -1023,6 +1049,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to /* Private constants ---------------------------------------------------------*/
/** @defgroup ADC_Private_Constants ADC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1053,12 +1080,14 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to /* Exported macro ------------------------------------------------------------*/
/** @defgroup ADC_Exported_Macros ADC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Macro for internal HAL driver usage, and possibly can be used into code of */
/* final user. */
/** @defgroup ADC_HAL_EM_HANDLE_IT_FLAG HAL ADC macro to manage HAL ADC handle, IT and flags.
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1188,6 +1217,7 @@ typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to */
/** @defgroup ADC_HAL_EM_HELPER_MACRO HAL ADC helper macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h index 4d2a29aa26..4921d22030 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Types ADC Extended Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -211,10 +212,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Constants ADC Extended Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_injected_external_trigger_source ADC group injected trigger source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* ADC group regular trigger sources for all ADC instances */
@@ -245,6 +248,7 @@ typedef struct */
/** @defgroup ADC_injected_external_trigger_edge ADC group injected trigger edge (when external trigger is selected)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_EXTERNALTRIGINJECCONV_EDGE_NONE (0x00000000UL) /*!< Injected conversions hardware trigger detection disabled */
@@ -256,6 +260,7 @@ typedef struct */
/** @defgroup ADC_HAL_EC_CHANNEL_SINGLE_DIFF_ENDING Channel - Single or differential ending
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_SINGLE_ENDED (LL_ADC_SINGLE_ENDED) /*!< ADC channel ending set to single ended (literal also used to set calibration mode) */
@@ -265,6 +270,7 @@ typedef struct */
/** @defgroup ADC_HAL_EC_OFFSET_NB ADC instance - Offset number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_OFFSET_NONE (ADC_OFFSET_4 + 1U) /*!< ADC offset disabled: no offset correction for the selected ADC channel */
@@ -277,6 +283,7 @@ typedef struct */
/** @defgroup ADC_INJ_SEQ_RANKS ADC group injected - Sequencer ranks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_INJECTED_RANK_1 (LL_ADC_INJ_RANK_1) /*!< ADC group injected sequencer rank 1 */
@@ -288,6 +295,7 @@ typedef struct */
/** @defgroup ADC_HAL_EC_MULTI_MODE Multimode - Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_MODE_INDEPENDENT (LL_ADC_MULTI_INDEPENDENT) /*!< ADC dual mode disabled (ADC independent mode) */
@@ -300,6 +308,7 @@ typedef struct #define ADC_DUALMODE_REGINTERL_INJECSIMULT (LL_ADC_MULTI_DUAL_REG_INT_INJ_SIM) /*!< ADC dual mode enabled: Combined group regular interleaved + group injected simultaneous */
/** @defgroup ADCEx_Dual_Mode_Data_Format ADC Extended Dual Mode Data Formatting
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_DUALMODEDATAFORMAT_DISABLED (0x00000000UL) /*!< Dual ADC mode without data packing: ADCx_CDR and ADCx_CDR2 registers not used */
@@ -310,6 +319,7 @@ typedef struct */
/** @defgroup ADC_HAL_EC_MULTI_TWOSMP_DELAY Multimode - Delay between two sampling phases
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_TWOSAMPLINGDELAY_1CYCLE (LL_ADC_MULTI_TWOSMP_DELAY_1CYCLE_5) /*!< ADC multimode delay between two sampling phases: 1 ADC clock cycle */
@@ -330,6 +340,7 @@ typedef struct */
/** @defgroup ADC_HAL_EC_GROUPS ADC instance - Groups
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_REGULAR_GROUP (LL_ADC_GROUP_REGULAR) /*!< ADC group regular (available on all STM32 devices) */
@@ -340,6 +351,7 @@ typedef struct */
/** @defgroup ADC_CFGR_fields ADCx CFGR fields
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_CFGR_FIELDS (ADC_CFGR_AWD1CH | ADC_CFGR_JAUTO | ADC_CFGR_JAWD1EN |\
@@ -353,6 +365,7 @@ typedef struct */
/** @defgroup ADC_SMPR1_fields ADCx SMPR1 fields
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_SMPR1_FIELDS (ADC_SMPR1_SMP9 | ADC_SMPR1_SMP8 | ADC_SMPR1_SMP7 |\
@@ -364,6 +377,7 @@ typedef struct */
/** @defgroup ADC_CFGR_fields_2 ADCx CFGR sub fields
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* ADC_CFGR fields of parameters that can be updated when no conversion
@@ -375,6 +389,7 @@ typedef struct #if defined(DFSDM1_Channel0)
/** @defgroup ADC_HAL_EC_REG_DFSDM_TRANSFER ADC group regular - DFSDM transfer of ADC conversion data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ADC_DFSDM_MODE_DISABLE (0x00000000UL) /*!< ADC conversions are not transferred by DFSDM. */
@@ -391,6 +406,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Macro ADC Extended Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -418,6 +434,7 @@ typedef struct /* Private macros ------------------------------------------------------------*/
/** @defgroup ADCEx_Private_Macro_internal_HAL_driver ADC Extended Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Macro reserved for internal HAL driver usage, not intended to be used in */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_cec.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_cec.h index f5e58987e2..718556cc10 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_cec.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_cec.h @@ -40,6 +40,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup CEC_Exported_Types CEC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -221,9 +222,11 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, /* Exported constants --------------------------------------------------------*/
/** @defgroup CEC_Exported_Constants CEC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CEC_State_Definition CEC State Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CEC_STATE_RESET ((uint32_t)0x00000000) /*!< Peripheral is not yet Initialized
@@ -243,6 +246,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, * @}
*/
/** @defgroup CEC_Error_Code CEC Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CEC_ERROR_NONE (uint32_t) 0x0000U /*!< no error */
@@ -263,6 +267,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Signal_Free_Time CEC Signal Free Time setting parameter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_DEFAULT_SFT ((uint32_t)0x00000000U)
@@ -278,6 +283,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Tolerance CEC Receiver Tolerance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_STANDARD_TOLERANCE ((uint32_t)0x00000000U)
@@ -287,6 +293,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_BRERxStop CEC Reception Stop on Error
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_NO_RX_STOP_ON_BRE ((uint32_t)0x00000000U)
@@ -296,6 +303,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_BREErrorBitGen CEC Error Bit Generation if Bit Rise Error reported
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_BRE_ERRORBIT_NO_GENERATION ((uint32_t)0x00000000U)
@@ -305,6 +313,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_LBPEErrorBitGen CEC Error Bit Generation if Long Bit Period Error reported
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_LBPE_ERRORBIT_NO_GENERATION ((uint32_t)0x00000000U)
@@ -314,6 +323,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_BroadCastMsgErrorBitGen CEC Error Bit Generation on Broadcast message
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_BROADCASTERROR_ERRORBIT_GENERATION ((uint32_t)0x00000000U)
@@ -323,6 +333,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_SFT_Option CEC Signal Free Time start option
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_SFT_START_ON_TXSOM ((uint32_t)0x00000000U)
@@ -332,6 +343,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Listening_Mode CEC Listening mode option
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_REDUCED_LISTENING_MODE ((uint32_t)0x00000000U)
@@ -341,6 +353,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_OAR_Position CEC Device Own Address position in CEC CFGR register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_CFGR_OAR_LSB_POS ((uint32_t) 16U)
@@ -349,6 +362,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Initiator_Position CEC Initiator logical address position in message header
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_INITIATOR_LSB_POS ((uint32_t) 4U)
@@ -357,6 +371,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_OWN_ADDRESS CEC Own Address
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_OWN_ADDRESS_NONE ((uint16_t) 0x0000U) /* Reset value */
@@ -380,6 +395,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Interrupts_Definitions CEC Interrupts definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_IT_TXACKE CEC_IER_TXACKEIE
@@ -400,6 +416,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_Flags_Definitions CEC Flags definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_FLAG_TXACKE CEC_ISR_TXACKE
@@ -420,6 +437,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_ALL_ERROR CEC all RX or TX errors flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_ISR_ALL_ERROR ((uint32_t)CEC_ISR_RXOVR|CEC_ISR_BRE|CEC_ISR_SBPE|CEC_ISR_LBPE|CEC_ISR_RXACKE|\
@@ -429,6 +447,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_IER_ALL_RX CEC all RX errors interrupts enabling flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_IER_RX_ALL_ERR ((uint32_t)CEC_IER_RXACKEIE|CEC_IER_LBPEIE|CEC_IER_SBPEIE|CEC_IER_BREIE|CEC_IER_RXOVRIE)
@@ -437,6 +456,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, */
/** @defgroup CEC_IER_ALL_TX CEC all TX errors interrupts enabling flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CEC_IER_TX_ALL_ERR ((uint32_t)CEC_IER_TXACKEIE|CEC_IER_TXERRIE|CEC_IER_TXUDRIE|CEC_IER_ARBLSTIE)
@@ -450,6 +470,7 @@ typedef void (*pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, /* Exported macros -----------------------------------------------------------*/
/** @defgroup CEC_Exported_Macros CEC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -688,6 +709,7 @@ uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec); /* Private types -------------------------------------------------------------*/
/** @defgroup CEC_Private_Types CEC Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -697,6 +719,7 @@ uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec); /* Private variables ---------------------------------------------------------*/
/** @defgroup CEC_Private_Variables CEC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -706,6 +729,7 @@ uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec); /* Private constants ---------------------------------------------------------*/
/** @defgroup CEC_Private_Constants CEC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -715,6 +739,7 @@ uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec); /* Private macros ------------------------------------------------------------*/
/** @defgroup CEC_Private_Macros CEC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -768,6 +793,7 @@ uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec); */
/* Private functions ---------------------------------------------------------*/
/** @defgroup CEC_Private_Functions CEC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_comp.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_comp.h index cea3606f4f..1b0a6ea0fc 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_comp.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_comp.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup COMP_Exported_Types COMP Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -136,10 +137,12 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup COMP_Exported_Constants COMP Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_Error_Code COMP Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_COMP_ERROR_NONE (0x00U) /*!< No error */
@@ -151,6 +154,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_WindowMode COMP Window Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_WINDOWMODE_DISABLE ((uint32_t)0x00000000) /*!< Window mode disable: Comparators instances pair COMP1 and COMP2 are independent */
@@ -161,6 +165,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_PowerMode COMP power mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Note: For the characteritics of comparator power modes */
@@ -174,6 +179,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_InputPlus COMP input plus (non-inverting input)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_INPUT_PLUS_IO1 ((uint32_t)0x00000000) /*!< Comparator input plus connected to IO1 (pin PB0 for COMP1, pin PE9 for COMP2) */
@@ -186,6 +192,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_InputMinus COMP input minus (inverting input)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_INPUT_MINUS_1_4VREFINT ( COMP_CFGRx_SCALEN | COMP_CFGRx_BRGEN) /*!< Comparator input minus connected to 1/4 VrefInt */
@@ -205,6 +212,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_Hysteresis COMP hysteresis
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_HYSTERESIS_NONE ((uint32_t)0x00000000) /*!< No hysteresis */
@@ -216,6 +224,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_OutputPolarity COMP Output Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_OUTPUTPOL_NONINVERTED ((uint32_t)0x00000000) /*!< COMP output level is not inverted (comparator output is high when the input plus is at a higher voltage than the input minus) */
@@ -226,6 +235,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /** @defgroup COMP_BlankingSrce COMP Blanking Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Any blanking source can be selected for all comparators */
@@ -244,6 +254,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /** @defgroup COMP_OutputLevel COMP Output Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -263,6 +274,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_EXTI_TriggerMode COMP output to EXTI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_TRIGGERMODE_NONE ((uint32_t)0x00000000) /*!< Comparator output triggering no External Interrupt Line */
@@ -278,6 +290,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_Flag COMP Flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_FLAG_C1I COMP_SR_C1IF /*!< Comparator 1 Interrupt Flag */
@@ -287,6 +300,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer * @}
*/
/** @defgroup COMP_IT_CLEAR_Flags COMP Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_CLEAR_C1IF COMP_ICFR_C1IF /*!< Clear Comparator 1 Interrupt Flag */
@@ -295,6 +309,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer * @}
*/
/** @defgroup COMP_Interrupts_Definitions COMP Interrupts Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_IT_EN COMP_CFGRx_ITEN
@@ -310,9 +325,11 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /* Exported macros -----------------------------------------------------------*/
/** @defgroup COMP_Exported_Macros COMP Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_Handle_Management COMP Handle Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -374,6 +391,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer */
/** @defgroup COMP_Exti_Management COMP external interrupt line management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -756,9 +774,11 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /* Private types -------------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup COMP_Private_Constants COMP Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_ExtiLine COMP EXTI Lines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_EXTI_LINE_COMP1 (EXTI_IMR1_IM20) /*!< EXTI line 20 connected to COMP1 output */
@@ -767,6 +787,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer * @}
*/
/** @defgroup COMP_ExtiLine COMP EXTI Lines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define COMP_EXTI_IT ((uint32_t) 0x01) /*!< EXTI line event with interruption */
@@ -782,9 +803,11 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer /* Private macros ------------------------------------------------------------*/
/** @defgroup COMP_Private_Macros COMP Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_GET_EXTI_LINE COMP Private macros to get EXTI line associated with Comparators
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -798,6 +821,7 @@ typedef void (*pCOMP_CallbackTypeDef)(COMP_HandleTypeDef *hcomp); /*!< pointer * @}
*/
/** @defgroup COMP_IS_COMP_Definitions COMP private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_COMP_WINDOWMODE(__WINDOWMODE__) (((__WINDOWMODE__) == COMP_WINDOWMODE_DISABLE) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_cortex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_cortex.h index 4eca439036..1b5d5b36bf 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_cortex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_cortex.h @@ -37,11 +37,13 @@ */
/* Exported types ------------------------------------------------------------*/
/** @defgroup CORTEX_Exported_Types Cortex Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (__MPU_PRESENT == 1)
/** @defgroup CORTEX_MPU_Region_Initialization_Structure_definition MPU Region Initialization Structure Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MPU Region initialization structure
* @{
*/
@@ -81,10 +83,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup CORTEX_Exported_Constants CORTEX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CORTEX_Preemption_Priority_Group CORTEX Preemption Priority Group
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define NVIC_PRIORITYGROUP_0 ((uint32_t)0x00000007) /*!< 0 bits for pre-emption priority
@@ -102,6 +106,7 @@ typedef struct */
/** @defgroup CORTEX_SysTick_clock_source CORTEX _SysTick clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SYSTICK_CLKSOURCE_HCLK_DIV8 ((uint32_t)0x00000000)
@@ -113,6 +118,7 @@ typedef struct #if (__MPU_PRESENT == 1)
/** @defgroup CORTEX_MPU_HFNMI_PRIVDEF_Control MPU HFNMI and PRIVILEGED Access control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_HFNMI_PRIVDEF_NONE ((uint32_t)0x00000000)
@@ -124,6 +130,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Region_Enable CORTEX MPU Region Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_REGION_ENABLE ((uint8_t)0x01)
@@ -133,6 +140,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Instruction_Access CORTEX MPU Instruction Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_INSTRUCTION_ACCESS_ENABLE ((uint8_t)0x00)
@@ -142,6 +150,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Access_Shareable CORTEX MPU Instruction Access Shareable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_ACCESS_SHAREABLE ((uint8_t)0x01)
@@ -151,6 +160,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Access_Cacheable CORTEX MPU Instruction Access Cacheable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_ACCESS_CACHEABLE ((uint8_t)0x01)
@@ -160,6 +170,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Access_Bufferable CORTEX MPU Instruction Access Bufferable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_ACCESS_BUFFERABLE ((uint8_t)0x01)
@@ -169,6 +180,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_TEX_Levels MPU TEX Levels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_TEX_LEVEL0 ((uint8_t)0x00)
@@ -179,6 +191,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Region_Size CORTEX MPU Region Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_REGION_SIZE_32B ((uint8_t)0x04)
@@ -214,6 +227,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Region_Permission_Attributes CORTEX MPU Region Permission Attributes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_REGION_NO_ACCESS ((uint8_t)0x00)
@@ -227,6 +241,7 @@ typedef struct */
/** @defgroup CORTEX_MPU_Region_Number CORTEX MPU Region Number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MPU_REGION_NUMBER0 ((uint8_t)0x00)
@@ -260,6 +275,7 @@ typedef struct /* Exported Macros -----------------------------------------------------------*/
/** @defgroup CORTEX_Exported_Macros CORTEX Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -270,6 +286,7 @@ typedef struct /** @defgroup CORTEX_CPU_Identifier CORTEX_CPU_Identifier
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CM7_CPUID ((uint32_t)0x00000003)
@@ -335,6 +352,7 @@ uint32_t HAL_GetCurrentCPUID(void); /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup CORTEX_Private_Macros CORTEX Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_NVIC_PRIORITY_GROUP(GROUP) (((GROUP) == NVIC_PRIORITYGROUP_0) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h index 224c8af85f..36c9144932 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup CRC_Exported_Types CRC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -125,10 +126,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup CRC_Exported_Constants CRC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_Default_Polynomial_Value Default CRC generating polynomial
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_CRC32_POLY 0x04C11DB7U /*!< X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2+ X +1 */
@@ -137,6 +140,7 @@ typedef struct */
/** @defgroup CRC_Default_InitValue Default CRC computation initialization value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_CRC_INITVALUE 0xFFFFFFFFU /*!< Initial CRC default value */
@@ -145,6 +149,7 @@ typedef struct */
/** @defgroup CRC_Default_Polynomial Indicates whether or not default polynomial is used
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_POLYNOMIAL_ENABLE ((uint8_t)0x00U) /*!< Enable default generating polynomial 0x04C11DB7 */
@@ -154,6 +159,7 @@ typedef struct */
/** @defgroup CRC_Default_InitValue_Use Indicates whether or not default init value is used
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEFAULT_INIT_VALUE_ENABLE ((uint8_t)0x00U) /*!< Enable initial CRC default value */
@@ -163,6 +169,7 @@ typedef struct */
/** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the peripheral
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CRC_POLYLENGTH_32B 0x00000000U /*!< Resort to a 32-bit long generating polynomial */
@@ -174,6 +181,7 @@ typedef struct */
/** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRC_LENGTH_32B 32U /*!< 32-bit long CRC */
@@ -185,6 +193,7 @@ typedef struct */
/** @defgroup CRC_Input_Buffer_Format Input Buffer Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
@@ -200,6 +209,7 @@ typedef struct */
/** @defgroup CRC_Aliases CRC API aliases
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRC_Input_Data_Reverse HAL_CRCEx_Input_Data_Reverse /*!< Aliased to HAL_CRCEx_Input_Data_Reverse for inter STM32 series compatibility */
@@ -214,6 +224,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup CRC_Exported_Macros CRC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -261,6 +272,7 @@ typedef struct /* Private macros --------------------------------------------------------*/
/** @defgroup CRC_Private_Macros CRC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -288,11 +300,13 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup CRC_Exported_Functions CRC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization and de-initialization functions ****************************/
/** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
@@ -305,6 +319,7 @@ void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc); /* Peripheral Control functions ***********************************************/
/** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
@@ -315,6 +330,7 @@ uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t /* Peripheral State and Error functions ***************************************/
/** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc_ex.h index 915dbf24af..d2851fdda4 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_crc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_crc_ex.h @@ -39,10 +39,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup CRCEx_Exported_Constants CRC Extended Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRCEx_Input_Data_Inversion Input Data Inversion Modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CRC_INPUTDATA_INVERSION_NONE 0x00000000U /*!< No input data inversion */
@@ -54,6 +56,7 @@ extern "C" { */
/** @defgroup CRCEx_Output_Data_Inversion Output Data Inversion Modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CRC_OUTPUTDATA_INVERSION_DISABLE 0x00000000U /*!< No output data inversion */
@@ -68,6 +71,7 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup CRCEx_Exported_Macros CRC Extended Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -99,6 +103,7 @@ extern "C" { /* Private macros --------------------------------------------------------*/
/** @defgroup CRCEx_Private_Macros CRC Extended Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp.h index 5c4741d8dc..7282ce09ae 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp.h @@ -39,6 +39,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup CRYP_Exported_Types CRYP Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -150,6 +151,7 @@ typedef struct #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
/** @defgroup HAL_CRYP_Callback_ID_enumeration_definition HAL CRYP Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL CRYP Callback ID enumeration definition
* @{
*/
@@ -168,6 +170,7 @@ typedef enum */
/** @defgroup HAL_CRYP_Callback_pointer_definition HAL CRYP Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL CRYP Callback pointer definition
* @{
*/
@@ -182,10 +185,12 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point /* Exported constants --------------------------------------------------------*/
/** @defgroup CRYP_Exported_Constants CRYP Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRYP_Error_Definition CRYP Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_CRYP_ERROR_NONE 0x00000000U /*!< No error */
@@ -206,6 +211,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point /** @defgroup CRYP_Data_Width_Unit CRYP Data Width Unit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -217,6 +223,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Algorithm_Mode CRYP Algorithm Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -235,6 +242,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Key_Size CRYP Key Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -247,6 +255,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Data_Type CRYP Data Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -260,6 +269,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Interrupt CRYP Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -271,6 +281,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Flags CRYP Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -290,6 +301,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point */
/** @defgroup CRYP_Configuration_Skip CRYP Key and IV Configuration Skip Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -306,6 +318,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point /* Exported macros -----------------------------------------------------------*/
/** @defgroup CRYP_Exported_Macros CRYP Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -394,6 +407,7 @@ typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp); /*!< point /* Exported functions --------------------------------------------------------*/
/** @defgroup CRYP_Exported_Functions CRYP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -455,10 +469,12 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); /* Private macros --------------------------------------------------------*/
/** @defgroup CRYP_Private_Macros CRYP Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRYP_IS_CRYP_Definitions CRYP Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -495,6 +511,7 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); /* Private constants ---------------------------------------------------------*/
/** @defgroup CRYP_Private_Constants CRYP Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -503,6 +520,7 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); */
/* Private defines -----------------------------------------------------------*/
/** @defgroup CRYP_Private_Defines CRYP Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -512,6 +530,7 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); /* Private variables ---------------------------------------------------------*/
/** @defgroup CRYP_Private_Variables CRYP Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -520,6 +539,7 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); */
/* Private functions prototypes ----------------------------------------------*/
/** @defgroup CRYP_Private_Functions_Prototypes CRYP Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -529,6 +549,7 @@ uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); /* Private functions ---------------------------------------------------------*/
/** @defgroup CRYP_Private_Functions CRYP Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp_ex.h index 66b510e917..6e40732e6e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_cryp_ex.h @@ -41,6 +41,7 @@ extern "C" { /* Private types -------------------------------------------------------------*/
/** @defgroup CRYPEx_Private_Types CRYPEx Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -50,6 +51,7 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/** @defgroup CRYPEx_Private_Variables CRYPEx Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -59,6 +61,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup CRYPEx_Private_Constants CRYPEx Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -68,6 +71,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup CRYPEx_Private_Macros CRYPEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -77,6 +81,7 @@ extern "C" { /* Private functions ---------------------------------------------------------*/
/** @defgroup CRYPEx_Private_Functions CRYPEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -86,6 +91,7 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup CRYPEx_Exported_Functions CRYPEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dac.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dac.h index b6debe3361..f5dbd28776 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dac.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dac.h @@ -41,6 +41,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup DAC_Exported_Types DAC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -173,10 +174,12 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); /* Exported constants --------------------------------------------------------*/
/** @defgroup DAC_Exported_Constants DAC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DAC_Error_Code DAC Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DAC_ERROR_NONE 0x00U /*!< No error */
@@ -193,6 +196,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_trigger_selection DAC trigger selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_TRIGGER_NONE 0x00000000U /*!< Conversion is automatic once the DAC_DHRxxxx register has been loaded, and not by external trigger */
@@ -227,6 +231,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_output_buffer DAC output buffer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_OUTPUTBUFFER_ENABLE 0x00000000U
@@ -237,6 +242,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_Channel_selection DAC Channel selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_CHANNEL_1 0x00000000U
@@ -246,6 +252,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_data_alignment DAC data alignment
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_ALIGN_12B_R 0x00000000U
@@ -257,6 +264,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_flags_definition DAC flags definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_FLAG_DMAUDR1 (DAC_SR_DMAUDR1)
@@ -267,6 +275,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_IT_definition DAC IT definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_IT_DMAUDR1 (DAC_SR_DMAUDR1)
@@ -277,6 +286,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_ConnectOnChipPeripheral DAC ConnectOnChipPeripheral
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_CHIPCONNECT_EXTERNAL (1UL << 0)
@@ -288,6 +298,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_UserTrimming DAC User Trimming
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_TRIMMING_FACTORY (0x00000000UL) /*!< Factory trimming */
@@ -297,6 +308,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_SampleAndHold DAC power mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_SAMPLEANDHOLD_DISABLE (0x00000000UL)
@@ -312,6 +324,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); /* Exported macro ------------------------------------------------------------*/
/** @defgroup DAC_Exported_Macros DAC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -420,6 +433,7 @@ typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); /* Private macro -------------------------------------------------------------*/
/** @defgroup DAC_Private_Macros DAC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
@@ -516,6 +530,7 @@ uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac); */
/** @defgroup DAC_Private_Functions DAC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void DAC_DMAConvCpltCh1(DMA_HandleTypeDef *hdma);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dac_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dac_ex.h index f98c28ed3b..4619beaceb 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dac_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dac_ex.h @@ -47,10 +47,12 @@ extern "C" { /* Exported constants --------------------------------------------------------*/
/** @defgroup DACEx_Exported_Constants DACEx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DACEx_lfsrunmask_triangleamplitude DACEx lfsrunmask triangle amplitude
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DAC_LFSRUNMASK_BIT0 0x00000000UL /*!< Unmask DAC channel LFSR bit0 for noise wave generation */
@@ -92,6 +94,7 @@ extern "C" { /* Private macro -------------------------------------------------------------*/
/** @defgroup DACEx_Private_Macros DACEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(HRTIM1)
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h index d592e61248..bd9415b96a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dcmi.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DCMI_Exported_Types DCMI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -184,10 +185,12 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup DCMI_Exported_Constants DCMI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DCMI_Error_Code DCMI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DCMI_ERROR_NONE (0x00000000U) /*!< No error */
@@ -203,6 +206,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Capture_Mode DCMI Capture Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_MODE_CONTINUOUS (0x00000000U) /*!< The received data are transferred continuously
@@ -214,6 +218,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_SYNCHRO_HARDWARE (0x00000000U) /*!< Hardware synchronization data capture (frame/line start/stop)
@@ -226,6 +231,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_PCKPOLARITY_FALLING (0x00000000U) /*!< Pixel clock active on Falling edge */
@@ -236,6 +242,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_VSPOLARITY_LOW (0x00000000U) /*!< Vertical synchronization active Low */
@@ -246,6 +253,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_HSPOLARITY_LOW (0x00000000U) /*!< Horizontal synchronization active Low */
@@ -256,6 +264,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_JPEG_DISABLE (0x00000000U) /*!< Mode JPEG Disabled */
@@ -266,6 +275,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Capture_Rate DCMI Capture Rate
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_CR_ALL_FRAME (0x00000000U) /*!< All frames are captured */
@@ -277,6 +287,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_EXTEND_DATA_8B (0x00000000U) /*!< Interface captures 8-bit data on every pixel clock */
@@ -289,6 +300,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_WINDOW_COORDINATE (0x3FFFU) /*!< Window coordinate */
@@ -298,6 +310,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Window_Height DCMI Window Height
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_WINDOW_HEIGHT (0x1FFFU) /*!< Window Height */
@@ -307,6 +320,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_interrupt_sources DCMI interrupt sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */
@@ -319,6 +333,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Flags DCMI Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -349,6 +364,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_BSM_ALL (0x00000000U) /*!< Interface captures all received data */
@@ -361,6 +377,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_OEBS_ODD (0x00000000U) /*!< Interface captures first data from the frame/line start, second one being dropped */
@@ -371,6 +388,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_LSM_ALL (0x00000000U) /*!< Interface captures all received lines */
@@ -381,6 +399,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer */
/** @defgroup DCMI_Line_Select_Start DCMI Line Select Start
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_OELS_ODD (0x00000000U) /*!< Interface captures first line from the frame start, second one being dropped */
@@ -396,6 +415,7 @@ typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer /* Exported macro ------------------------------------------------------------*/
/** @defgroup DCMI_Exported_Macros DCMI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -584,6 +604,7 @@ uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup DCMI_Private_Constants DCMI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCMI_MIS_INDEX ((uint32_t)0x1000) /*!< DCMI MIS register index */
@@ -593,6 +614,7 @@ uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); */
/* Private macro -------------------------------------------------------------*/
/** @defgroup DCMI_Private_Macros DCMI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dfsdm.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dfsdm.h index c5c9215983..e621873b52 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dfsdm.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dfsdm.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DFSDM_Exported_Types DFSDM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -296,10 +297,12 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf /* Exported constants --------------------------------------------------------*/
/** @defgroup DFSDM_Exported_Constants DFSDM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DFSDM_Channel_OuputClock DFSDM channel output clock selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_OUTPUT_CLOCK_SYSTEM 0x00000000U /*!< Source for ouput clock is system clock */
@@ -309,6 +312,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_InputMultiplexer DFSDM channel input multiplexer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_EXTERNAL_INPUTS 0x00000000U /*!< Data are taken from external inputs */
@@ -319,6 +323,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_DataPacking DFSDM channel input data packing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_STANDARD_MODE 0x00000000U /*!< Standard data packing mode */
@@ -329,6 +334,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_InputPins DFSDM channel input pins
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_SAME_CHANNEL_PINS 0x00000000U /*!< Input from pins on same channel */
@@ -338,6 +344,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_SerialInterfaceType DFSDM channel serial interface type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_SPI_RISING 0x00000000U /*!< SPI with rising edge */
@@ -349,6 +356,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_SpiClock DFSDM channel SPI clock selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_SPI_CLOCK_EXTERNAL 0x00000000U /*!< External SPI clock */
@@ -360,6 +368,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_AwdFilterOrder DFSDM channel analog watchdog filter order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CHANNEL_FASTSINC_ORDER 0x00000000U /*!< FastSinc filter type */
@@ -371,6 +380,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_Trigger DFSDM filter conversion trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_SW_TRIGGER 0x00000000U /*!< Software trigger */
@@ -381,6 +391,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_ExtTrigger DFSDM filter external trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_EXT_TRIG_TIM1_TRGO 0x00000000U /*!< For all DFSDM filters */
@@ -410,6 +421,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_ExtTriggerEdge DFSDM filter external trigger edge
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_EXT_TRIG_RISING_EDGE DFSDM_FLTCR1_JEXTEN_0 /*!< External rising edge */
@@ -420,6 +432,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_SincOrder DFSDM filter sinc order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_FASTSINC_ORDER 0x00000000U /*!< FastSinc filter type */
@@ -433,6 +446,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_AwdDataSource DFSDM filter analog watchdog data source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_AWD_FILTER_DATA 0x00000000U /*!< From digital filter */
@@ -442,6 +456,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Filter_ErrorCode DFSDM filter error code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_FILTER_ERROR_NONE 0x00000000U /*!< No error */
@@ -456,6 +471,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_BreakSignals DFSDM break signals
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_NO_BREAK_SIGNAL 0x00000000U /*!< No break signal */
@@ -468,6 +484,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_Channel_Selection DFSDM Channel Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* DFSDM Channels ------------------------------------------------------------*/
@@ -491,6 +508,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_ContinuousMode DFSDM Continuous Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_CONTINUOUS_CONV_OFF 0x00000000U /*!< Conversion are not continuous */
@@ -500,6 +518,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf */
/** @defgroup DFSDM_AwdThreshold DFSDM analog watchdog threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DFSDM_AWD_HIGH_THRESHOLD 0x00000000U /*!< Analog watchdog high threshold */
@@ -515,6 +534,7 @@ typedef void (*pDFSDM_Filter_AwdCallbackTypeDef)(DFSDM_Filter_HandleTypeDef *hdf /* Exported macros -----------------------------------------------------------*/
/** @defgroup DFSDM_Exported_Macros DFSDM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -609,6 +629,7 @@ void HAL_DFSDM_ChannelScdCallback(DFSDM_Channel_HandleTypeDef *hdfsdm_channel); */
/** @defgroup DFSDM_Exported_Functions_Group3_Channel Channel state function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Channel state function *****************************************************/
@@ -700,6 +721,7 @@ void HAL_DFSDM_FilterErrorCallback(DFSDM_Filter_HandleTypeDef *hdfsdm_filter); */
/** @defgroup DFSDM_Exported_Functions_Group4_Filter Filter state functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Filter state functions *****************************************************/
@@ -716,6 +738,7 @@ uint32_t HAL_DFSDM_FilterGetError(DFSDM_Filter_HandleTypeDe /* Private macros ------------------------------------------------------------*/
/** @defgroup DFSDM_Private_Macros DFSDM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DFSDM_CHANNEL_OUTPUT_CLOCK(CLOCK) (((CLOCK) == DFSDM_CHANNEL_OUTPUT_CLOCK_SYSTEM) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma.h index 36d553b0a6..0f86c57123 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DMA_Exported_Types DMA Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Exported Types
* @{
*/
@@ -187,11 +188,13 @@ typedef struct __DMA_HandleTypeDef /* Exported constants --------------------------------------------------------*/
/** @defgroup DMA_Exported_Constants DMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Exported constants
* @{
*/
/** @defgroup DMA_Error_Code DMA Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Error Code
* @{
*/
@@ -212,6 +215,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Request_selection DMA Request selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Request selection
* @{
*/
@@ -421,6 +425,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Data_transfer_direction DMA Data transfer direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA data transfer direction
* @{
*/
@@ -432,6 +437,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Peripheral_incremented_mode DMA Peripheral incremented mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA peripheral incremented mode
* @{
*/
@@ -442,6 +448,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Memory_incremented_mode DMA Memory incremented mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA memory incremented mode
* @{
*/
@@ -452,6 +459,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Peripheral_data_size DMA Peripheral data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA peripheral data size
* @{
*/
@@ -463,6 +471,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Memory_data_size DMA Memory data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA memory data size
* @{
*/
@@ -474,6 +483,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_mode DMA mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA mode
* @{
*/
@@ -487,6 +497,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Priority_level DMA Priority level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA priority levels
* @{
*/
@@ -499,6 +510,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_FIFO_direct_mode DMA FIFO direct mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA FIFO direct mode
* @{
*/
@@ -509,6 +521,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_FIFO_threshold_level DMA FIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA FIFO level
* @{
*/
@@ -521,6 +534,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Memory_burst DMA Memory burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA memory burst
* @{
*/
@@ -533,6 +547,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_Peripheral_burst DMA Peripheral burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA peripheral burst
* @{
*/
@@ -545,6 +560,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_interrupt_enable_definitions DMA interrupt enable definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA interrupts definition
* @{
*/
@@ -558,6 +574,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup DMA_flag_definitions DMA flag definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA flag definitions
* @{
*/
@@ -586,6 +603,7 @@ typedef struct __DMA_HandleTypeDef */
/** @defgroup BDMA_flag_definitions BDMA flag definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief BDMA flag definitions
* @{
*/
@@ -632,6 +650,7 @@ typedef struct __DMA_HandleTypeDef /* Exported macro ------------------------------------------------------------*/
/** @defgroup DMA_Exported_Macros DMA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1142,11 +1161,13 @@ typedef struct __DMA_HandleTypeDef /* Exported functions --------------------------------------------------------*/
/** @defgroup DMA_Exported_Functions DMA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Exported functions
* @{
*/
/** @defgroup DMA_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions
* @{
*/
@@ -1157,6 +1178,7 @@ HAL_StatusTypeDef HAL_DMA_DeInit(DMA_HandleTypeDef *hdma); */
/** @defgroup DMA_Exported_Functions_Group2 I/O operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I/O operation functions
* @{
*/
@@ -1174,6 +1196,7 @@ HAL_StatusTypeDef HAL_DMA_UnRegisterCallback(DMA_HandleTypeDef *hdma, HAL_DMA_Ca */
/** @defgroup DMA_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
* @{
*/
@@ -1187,6 +1210,7 @@ uint32_t HAL_DMA_GetError(DMA_HandleTypeDef *hdma); */
/* Private Constants -------------------------------------------------------------*/
/** @defgroup DMA_Private_Constants DMA Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA private defines and constants
* @{
*/
@@ -1196,6 +1220,7 @@ uint32_t HAL_DMA_GetError(DMA_HandleTypeDef *hdma); /* Private macros ------------------------------------------------------------*/
/** @defgroup DMA_Private_Macros DMA Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA private macros
* @{
*/
@@ -1266,6 +1291,7 @@ uint32_t HAL_DMA_GetError(DMA_HandleTypeDef *hdma); /* Private functions ---------------------------------------------------------*/
/** @defgroup DMA_Private_Functions DMA Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA private functions
* @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma2d.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma2d.h index 28ca638beb..7a19a59d45 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma2d.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma2d.h @@ -41,6 +41,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DMA2D_Exported_Types DMA2D Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MAX_DMA2D_LAYER 2U /*!< DMA2D maximum number of layers */
@@ -180,10 +181,12 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin /* Exported constants --------------------------------------------------------*/
/** @defgroup DMA2D_Exported_Constants DMA2D Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_Error_Code DMA2D Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DMA2D_ERROR_NONE 0x00000000U /*!< No error */
@@ -200,6 +203,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Mode DMA2D Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_M2M 0x00000000U /*!< DMA2D memory to memory transfer mode */
@@ -213,6 +217,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Output_Color_Mode DMA2D Output Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_OUTPUT_ARGB8888 0x00000000U /*!< ARGB8888 DMA2D color mode */
@@ -225,6 +230,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Input_Color_Mode DMA2D Input Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_INPUT_ARGB8888 0x00000000U /*!< ARGB8888 color mode */
@@ -244,6 +250,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Alpha_Mode DMA2D Alpha Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_NO_MODIF_ALPHA 0x00000000U /*!< No modification of the alpha channel value */
@@ -255,6 +262,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Alpha_Inverted DMA2D Alpha Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_REGULAR_ALPHA 0x00000000U /*!< No modification of the alpha channel value */
@@ -264,6 +272,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_RB_Swap DMA2D Red and Blue Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_RB_REGULAR 0x00000000U /*!< Select regular mode (RGB or ARGB) */
@@ -275,6 +284,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin /** @defgroup DMA2D_Line_Offset_Mode DMA2D Line Offset Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_LOM_PIXELS 0x00000000U /*!< Line offsets expressed in pixels */
@@ -284,6 +294,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Bytes_Swap DMA2D Bytes Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_BYTES_REGULAR 0x00000000U /*!< Bytes in regular order in output FIFO */
@@ -293,6 +304,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Chroma_Sub_Sampling DMA2D Chroma Sub Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_NO_CSS 0x00000000U /*!< No chroma sub-sampling 4:4:4 */
@@ -303,6 +315,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_CLUT_CM DMA2D CLUT Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_CCM_ARGB8888 0x00000000U /*!< ARGB8888 DMA2D CLUT color mode */
@@ -312,6 +325,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Interrupts DMA2D Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_IT_CE DMA2D_CR_CEIE /*!< Configuration Error Interrupt */
@@ -325,6 +339,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Flags DMA2D Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_FLAG_CE DMA2D_ISR_CEIF /*!< Configuration Error Interrupt Flag */
@@ -338,6 +353,7 @@ typedef void (*pDMA2D_CallbackTypeDef)(DMA2D_HandleTypeDef * hdma2d); /*!< Poin */
/** @defgroup DMA2D_Aliases DMA2D API Aliases
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DMA2D_DisableCLUT HAL_DMA2D_CLUTLoading_Abort /*!< Aliased to HAL_DMA2D_CLUTLoading_Abort for compatibility with legacy code */
@@ -366,6 +382,7 @@ typedef enum */
/* Exported macros ------------------------------------------------------------*/
/** @defgroup DMA2D_Exported_Macros DMA2D Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -565,6 +582,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Maximum_Line_WaterMark DMA2D Maximum Line Watermark
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_LINE_WATERMARK_MAX DMA2D_LWR_LW /*!< DMA2D maximum line watermark */
@@ -573,6 +591,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Color_Value DMA2D Color Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_COLOR_VALUE 0x000000FFU /*!< Color value mask */
@@ -581,6 +600,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Max_Layer DMA2D Maximum Number of Layers
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_MAX_LAYER 2U /*!< DMA2D maximum number of layers */
@@ -589,6 +609,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Layers DMA2D Layers
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_BACKGROUND_LAYER 0x00000000U /*!< DMA2D Background Layer (layer 0) */
@@ -598,6 +619,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Offset DMA2D Offset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_OFFSET DMA2D_FGOR_LO /*!< maximum Line Offset */
@@ -606,6 +628,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_Size DMA2D Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_PIXEL (DMA2D_NLR_PL >> 16U) /*!< DMA2D maximum number of pixels per line */
@@ -615,6 +638,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); */
/** @defgroup DMA2D_CLUT_Size DMA2D CLUT Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DMA2D_CLUT_SIZE (DMA2D_FGPFCCR_CS >> 8U) /*!< DMA2D maximum CLUT size */
@@ -629,6 +653,7 @@ uint32_t HAL_DMA2D_GetError(DMA2D_HandleTypeDef *hdma2d); /* Private macros ------------------------------------------------------------*/
/** @defgroup DMA2D_Private_Macros DMA2D Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DMA2D_LAYER(LAYER) (((LAYER) == DMA2D_BACKGROUND_LAYER) || ((LAYER) == DMA2D_FOREGROUND_LAYER))
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma_ex.h index 4125ae7e6c..fedf61187d 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dma_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dma_ex.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DMAEx_Exported_Types DMAEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx Exported types
* @{
*/
@@ -99,11 +100,13 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup DMAEx_Exported_Constants DMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx Exported constants
* @{
*/
/** @defgroup DMAEx_MUX_SyncSignalID_selection DMAEx MUX SyncSignalID selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx MUX SyncSignalID selection
* @{
*/
@@ -138,6 +141,7 @@ typedef struct */
/** @defgroup DMAEx_MUX_SyncPolarity_selection DMAEx MUX SyncPolarity selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx MUX SyncPolarity selection
* @{
*/
@@ -152,6 +156,7 @@ typedef struct /** @defgroup DMAEx_MUX_SignalGeneratorID_selection DMAEx MUX SignalGeneratorID selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx MUX SignalGeneratorID selection
* @{
*/
@@ -207,6 +212,7 @@ typedef struct */
/** @defgroup DMAEx_MUX_RequestGeneneratorPolarity_selection DMAEx MUX RequestGeneneratorPolarity selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx MUX RequestGeneneratorPolarity selection
* @{
*/
@@ -225,11 +231,13 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup DMAEx_Exported_Functions DMAEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx Exported functions
* @{
*/
/** @defgroup DMAEx_Exported_Functions_Group1 Extended features functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Extended features functions
* @{
*/
@@ -253,6 +261,7 @@ void HAL_DMAEx_MUX_IRQHandler(DMA_HandleTypeDef *hdma); /* Private macros ------------------------------------------------------------*/
/** @defgroup DMAEx_Private_Macros DMA Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx private macros
* @{
*/
@@ -288,6 +297,7 @@ void HAL_DMAEx_MUX_IRQHandler(DMA_HandleTypeDef *hdma); /* Private functions ---------------------------------------------------------*/
/** @defgroup DMAEx_Private_Functions DMAEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMAEx Private functions
* @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h index ca5293a825..f7425a48a1 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h @@ -34,6 +34,7 @@ extern "C" { */
/** @defgroup DSI DSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DSI HAL module driver
* @{
*/
@@ -348,9 +349,11 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup DSI_Exported_Constants DSI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DSI_DCS_Command DSI DCS Command
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_ENTER_IDLE_MODE 0x39U
@@ -402,6 +405,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Video_Mode_Type DSI Video Mode Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_VID_MODE_NB_PULSES 0U
@@ -412,6 +416,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Color_Mode DSI Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_COLOR_MODE_FULL 0x00000000U
@@ -421,6 +426,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_ShutDown DSI ShutDown
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_DISPLAY_ON 0x00000000U
@@ -430,6 +436,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_Command DSI LP Command
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_COMMAND_DISABLE 0x00000000U
@@ -439,6 +446,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_HFP DSI LP HFP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_HFP_DISABLE 0x00000000U
@@ -448,6 +456,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_HBP DSI LP HBP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_HBP_DISABLE 0x00000000U
@@ -457,6 +466,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_VACT DSI LP VACT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_VACT_DISABLE 0x00000000U
@@ -466,6 +476,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_VFP DSI LP VFP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_VFP_DISABLE 0x00000000U
@@ -475,6 +486,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_VBP DSI LP VBP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_VBP_DISABLE 0x00000000U
@@ -484,6 +496,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_VSYNC DSI LP VSYNC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_VSYNC_DISABLE 0x00000000U
@@ -493,6 +506,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_FBTA_acknowledge DSI FBTA Acknowledge
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_FBTAA_DISABLE 0x00000000U
@@ -502,6 +516,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_TearingEffectSource DSI Tearing Effect Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_TE_DSILINK 0x00000000U
@@ -511,6 +526,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_TearingEffectPolarity DSI Tearing Effect Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_TE_RISING_EDGE 0x00000000U
@@ -520,6 +536,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Vsync_Polarity DSI Vsync Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_VSYNC_FALLING 0x00000000U
@@ -529,6 +546,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_AutomaticRefresh DSI Automatic Refresh
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_AR_DISABLE 0x00000000U
@@ -538,6 +556,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_TE_AcknowledgeRequest DSI TE Acknowledge Request
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_TE_ACKNOWLEDGE_DISABLE 0x00000000U
@@ -547,6 +566,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_AcknowledgeRequest DSI Acknowledge Request
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_ACKNOWLEDGE_DISABLE 0x00000000U
@@ -556,6 +576,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortWriteNoP DSI LP LPGen Short Write NoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSW0P_DISABLE 0x00000000U
@@ -565,6 +586,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortWriteOneP DSI LP LPGen Short Write OneP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSW1P_DISABLE 0x00000000U
@@ -574,6 +596,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortWriteTwoP DSI LP LPGen Short Write TwoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSW2P_DISABLE 0x00000000U
@@ -583,6 +606,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortReadNoP DSI LP LPGen Short Read NoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSR0P_DISABLE 0x00000000U
@@ -592,6 +616,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortReadOneP DSI LP LPGen Short Read OneP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSR1P_DISABLE 0x00000000U
@@ -601,6 +626,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenShortReadTwoP DSI LP LPGen Short Read TwoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GSR2P_DISABLE 0x00000000U
@@ -610,6 +636,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPGenLongWrite DSI LP LPGen LongWrite
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_GLW_DISABLE 0x00000000U
@@ -619,6 +646,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPDcsShortWriteNoP DSI LP LPDcs Short Write NoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_DSW0P_DISABLE 0x00000000U
@@ -628,6 +656,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPDcsShortWriteOneP DSI LP LPDcs Short Write OneP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_DSW1P_DISABLE 0x00000000U
@@ -637,6 +666,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPDcsShortReadNoP DSI LP LPDcs Short Read NoP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_DSR0P_DISABLE 0x00000000U
@@ -646,6 +676,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPDcsLongWrite DSI LP LPDcs Long Write
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_DLW_DISABLE 0x00000000U
@@ -655,6 +686,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LP_LPMaxReadPacket DSI LP LPMax Read Packet
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LP_MRDP_DISABLE 0x00000000U
@@ -664,6 +696,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_HS_PrespMode DSI HS Presp Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_HS_PM_DISABLE 0x00000000U
@@ -674,6 +707,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /** @defgroup DSI_Automatic_Clk_Lane_Control DSI Automatic Clk Lane Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_AUTO_CLK_LANE_CTRL_DISABLE 0x00000000U
@@ -683,6 +717,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Number_Of_Lanes DSI Number Of Lanes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_ONE_DATA_LANE 0U
@@ -692,6 +727,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_FlowControl DSI Flow Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_FLOW_CONTROL_CRC_RX DSI_PCR_CRCRXE
@@ -707,6 +743,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Color_Coding DSI Color Coding
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_RGB565 0x00000000U /*!< The values 0x00000001 and 0x00000002 can also be used for the RGB565 color mode configuration */
@@ -717,6 +754,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LooselyPacked DSI Loosely Packed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_LOOSELY_PACKED_ENABLE DSI_LCOLCR_LPE
@@ -726,6 +764,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_HSYNC_Polarity DSI HSYNC Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_HSYNC_ACTIVE_HIGH 0x00000000U
@@ -735,6 +774,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_VSYNC_Active_Polarity DSI VSYNC Active Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_VSYNC_ACTIVE_HIGH 0x00000000U
@@ -744,6 +784,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_DATA_ENABLE_Polarity DSI DATA ENABLE Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_DATA_ENABLE_ACTIVE_HIGH 0x00000000U
@@ -753,6 +794,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_PLL_IDF DSI PLL IDF
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_PLL_IN_DIV1 0x00000001U
@@ -767,6 +809,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_PLL_ODF DSI PLL ODF
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_PLL_OUT_DIV1 0x00000000U
@@ -778,6 +821,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Flags DSI Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_FLAG_TE DSI_WISR_TEIF
@@ -793,6 +837,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Interrupts DSI Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_IT_TE DSI_WIER_TEIE
@@ -805,6 +850,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_SHORT_WRITE_PKT_Data_Type DSI SHORT WRITE PKT Data Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_DCS_SHORT_PKT_WRITE_P0 0x00000005U /*!< DCS short write, no parameters */
@@ -817,6 +863,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_LONG_WRITE_PKT_Data_Type DSI LONG WRITE PKT Data Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_DCS_LONG_PKT_WRITE 0x00000039U /*!< DCS long write */
@@ -826,6 +873,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_SHORT_READ_PKT_Data_Type DSI SHORT READ PKT Data Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_DCS_SHORT_PKT_READ 0x00000006U /*!< DCS short read */
@@ -837,6 +885,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Error_Data_Type DSI Error Data Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_DSI_ERROR_NONE 0U
@@ -858,6 +907,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Lane_Group DSI Lane Group
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_CLOCK_LANE 0x00000000U
@@ -867,6 +917,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Communication_Delay DSI Communication Delay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_SLEW_RATE_HSTX 0x00000000U
@@ -877,6 +928,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_CustomLane DSI CustomLane
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_SWAP_LANE_PINS 0x00000000U
@@ -886,6 +938,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_Lane_Select DSI Lane Select
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_CLK_LANE 0x00000000U
@@ -896,6 +949,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */
/** @defgroup DSI_PHY_Timing DSI PHY Timing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_TCLK_POST 0x00000000U
@@ -917,6 +971,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported macros -----------------------------------------------------------*/
/** @defgroup DSI_Exported_Macros DSI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1118,6 +1173,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported functions --------------------------------------------------------*/
/** @defgroup DSI_Exported_Functions DSI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_DSI_Init(DSI_HandleTypeDef *hdsi, DSI_PLLInitTypeDef *PLLInit);
@@ -1198,6 +1254,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private types -------------------------------------------------------------*/
/** @defgroup DSI_Private_Types DSI Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1207,6 +1264,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private defines -----------------------------------------------------------*/
/** @defgroup DSI_Private_Defines DSI Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1216,6 +1274,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private variables ---------------------------------------------------------*/
/** @defgroup DSI_Private_Variables DSI Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1225,6 +1284,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private constants ---------------------------------------------------------*/
/** @defgroup DSI_Private_Constants DSI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSI_MAX_RETURN_PKT_SIZE (0x00000037U) /*!< Maximum return packet configuration */
@@ -1234,6 +1294,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private macros ------------------------------------------------------------*/
/** @defgroup DSI_Private_Macros DSI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DSI_PLL_NDIV(NDIV) ((10U <= (NDIV)) && ((NDIV) <= 125U))
@@ -1318,6 +1379,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup DSI_Private_Functions_Prototypes DSI Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1327,6 +1389,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private functions ---------------------------------------------------------*/
/** @defgroup DSI_Private_Functions DSI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dts.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dts.h index 3aec6cbe0f..0cc893ecc6 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dts.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dts.h @@ -39,6 +39,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup DTS_Exported_Types DTS Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -111,10 +112,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup DTS_Exported_Constants DTS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DTS_TriggerConfig DTS Trigger Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* @brief No Hardware trigger detection */
@@ -136,6 +139,7 @@ typedef struct */
/** @defgroup DTS_Quick_Measurement DTS Quick Measurement
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_QUICKMEAS_ENABLE DTS_CFGR1_Q_MEAS_OPT /*!< Enable the Quick Measure (Measure without calibration) */
@@ -145,6 +149,7 @@ typedef struct */
/** @defgroup DTS_Reference_Clock_Selection DTS Reference Clock Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_REFCLKSEL_LSE DTS_CFGR1_REFCLK_SEL /*!< Low speed REF clock (LSE) */
@@ -154,6 +159,7 @@ typedef struct */
/** @defgroup DTS_Sampling_Time DTS Sampling Time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_SMP_TIME_1_CYCLE DTS_CFGR1_TS1_SMP_TIME_0 /*!< 1 clock cycle for the sampling time */
@@ -175,6 +181,7 @@ typedef struct * @}
*/
/** @defgroup DTS_Flag_Definitions DTS Flag Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_FLAG_TS1_ITE DTS_SR_TS1_ITEF /*!< Interrupt flag for end of measure for DTS1 */
@@ -189,6 +196,7 @@ typedef struct */
/** @defgroup DTS_Interrupts_Definitions DTS Interrupts Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_IT_TS1_ITE DTS_ITENR_TS1_ITEEN /*!< Enable interrupt flag for end of measure for DTS1 */
@@ -206,6 +214,7 @@ typedef struct */
/* Exported macros -----------------------------------------------------------*/
/** @defgroup DTS_Exported_Macros DTS Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -401,9 +410,11 @@ void HAL_DTS_AsyncHighCallback(DTS_HandleTypeDef *hdts); /* Private types -------------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup DTS_Private_Constants DTS Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DTS_ExtiLine DTS EXTI Lines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DTS_EXTI_LINE_DTS1 (EXTI_IMR3_IM88) /*!< EXTI line 88 connected to DTS1 output */
@@ -416,10 +427,12 @@ void HAL_DTS_AsyncHighCallback(DTS_HandleTypeDef *hdts); /* Private macros ------------------------------------------------------------*/
/** @defgroup DTS_Private_Macros DTS Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DTS_IS_DTS_Definitions DTS Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_DTS_QUICKMEAS(__SEL__) (((__SEL__) == DTS_QUICKMEAS_DISABLE) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h index bb2bacd68e..092999ef67 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth.h @@ -48,6 +48,7 @@ /*********************** Descriptors struct def section ************************/
/** @defgroup ETH_Exported_Types ETH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -536,10 +537,12 @@ typedef struct{ /* Exported constants --------------------------------------------------------*/
/** @defgroup ETH_Exported_Constants ETH Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ETH_DMA_Tx_Descriptor_Bit_Definition ETH DMA Tx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -708,6 +711,7 @@ typedef struct{ /** @defgroup ETH_DMA_Rx_Descriptor_Bit_Definition ETH DMA Rx Descriptor Bit Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -867,6 +871,7 @@ typedef struct{ */
/** @defgroup ETH_Frame_settings ETH frame settings
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAX_PACKET_SIZE ((uint32_t)1528U) /*!< ETH_HEADER + 2*VLAN_TAG + MAX_ETH_PAYLOAD + ETH_CRC */
@@ -881,6 +886,7 @@ typedef struct{ */
/** @defgroup ETH_Error_Code ETH Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_ETH_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -897,6 +903,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Attributes ETH Tx Packet Attributes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TX_PACKETS_FEATURES_CSUM ((uint32_t)0x00000001U)
@@ -910,6 +917,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Source_Addr_Control ETH Tx Packet Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SRC_ADDR_CONTROL_DISABLE ETH_DMATXNDESCRF_SAIC_DISABLE
@@ -920,6 +928,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_CRC_Pad_Control ETH Tx Packet CRC Pad Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CRC_PAD_DISABLE ETH_DMATXNDESCRF_CPC_DISABLE
@@ -931,6 +940,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Checksum_Control ETH Tx Packet Checksum Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CHECKSUM_DISABLE ETH_DMATXNDESCRF_CIC_DISABLE
@@ -942,6 +952,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_VLAN_Control ETH Tx Packet VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLAN_DISABLE ETH_DMATXNDESCRF_VTIR_DISABLE
@@ -953,6 +964,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_Packet_Inner_VLAN_Control ETH Tx Packet Inner VLAN Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INNER_VLAN_DISABLE ETH_DMATXCDESC_IVTIR_DISABLE
@@ -964,6 +976,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Checksum_Status ETH Rx Checksum Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CHECKSUM_BYPASSED ETH_DMARXNDESCWBF_IPCB
@@ -974,6 +987,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_IP_Header_Type ETH Rx IP Header Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_IP_HEADER_IPV4 ETH_DMARXNDESCWBF_IPV4
@@ -983,6 +997,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Payload_Type ETH Rx Payload Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_IP_PAYLOAD_UNKNOWN ETH_DMARXNDESCWBF_PT_UNKNOWN
@@ -994,6 +1009,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_MAC_Filter_Status ETH Rx MAC Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_HASH_FILTER_PASS ETH_DMARXNDESCWBF_HF
@@ -1005,6 +1021,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_L3_Filter_Status ETH Rx L3 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_FILTER0_MATCH ETH_DMARXNDESCWBF_L3FM
@@ -1014,6 +1031,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_L4_Filter_Status ETH Rx L4 Filter Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_FILTER0_MATCH ETH_DMARXNDESCWBF_L4FM
@@ -1023,6 +1041,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_Error_Code ETH Rx Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DRIBBLE_BIT_ERROR ETH_DMARXNDESCWBF_DE
@@ -1036,6 +1055,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Arbitration ETH DMA Arbitration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMAARBITRATION_RX ETH_DMAMR_DA
@@ -1061,6 +1081,7 @@ typedef struct{ */
/** @defgroup ETH_Burst_Mode ETH Burst Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_BURSTLENGTH_FIXED ETH_DMASBMR_FB
@@ -1071,6 +1092,7 @@ typedef struct{ */
/** @defgroup ETH_Tx_DMA_Burst_Length ETH Tx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TXDMABURSTLENGTH_1BEAT ETH_DMACTCR_TPBL_1PBL
@@ -1084,6 +1106,7 @@ typedef struct{ */
/** @defgroup ETH_Rx_DMA_Burst_Length ETH Rx DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RXDMABURSTLENGTH_1BEAT ETH_DMACRCR_RPBL_1PBL
@@ -1097,6 +1120,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Interrupts ETH DMA Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMA_NORMAL_IT ETH_DMACIER_NIE
@@ -1117,6 +1141,7 @@ typedef struct{ */
/** @defgroup ETH_DMA_Status_Flags ETH DMA Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_DMA_RX_NO_ERROR_FLAG ((uint32_t)0x00000000U)
@@ -1141,6 +1166,7 @@ typedef struct{ */
/** @defgroup ETH_Transmit_Mode ETH Transmit Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TRANSMITSTOREFORWARD ETH_MTLTQOMR_TSF
@@ -1157,6 +1183,7 @@ typedef struct{ */
/** @defgroup ETH_Receive_Mode ETH Receive Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RECEIVESTOREFORWARD ETH_MTLRQOMR_RSF
@@ -1169,6 +1196,7 @@ typedef struct{ */
/** @defgroup ETH_Pause_Low_Threshold ETH Pause Low Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_PAUSELOWTHRESHOLD_MINUS_4 ETH_MACTFCR_PLT_MINUS4
@@ -1182,6 +1210,7 @@ typedef struct{ */
/** @defgroup ETH_Watchdog_Timeout ETH Watchdog Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_WATCHDOGTIMEOUT_2KB ETH_MACWTR_WTO_2KB
@@ -1204,6 +1233,7 @@ typedef struct{ */
/** @defgroup ETH_Inter_Packet_Gap ETH Inter Packet Gap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INTERPACKETGAP_96BIT ETH_MACCR_IPG_96BIT
@@ -1219,6 +1249,7 @@ typedef struct{ */
/** @defgroup ETH_Speed ETH Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SPEED_10M ((uint32_t)0x00000000U)
@@ -1228,6 +1259,7 @@ typedef struct{ */
/** @defgroup ETH_Duplex_Mode ETH Duplex Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_FULLDUPLEX_MODE ETH_MACCR_DM
@@ -1237,6 +1269,7 @@ typedef struct{ */
/** @defgroup ETH_Back_Off_Limit ETH Back Off Limit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_BACKOFFLIMIT_10 ETH_MACCR_BL_10
@@ -1248,6 +1281,7 @@ typedef struct{ */
/** @defgroup ETH_Preamble_Length ETH Preamble Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_PREAMBLELENGTH_7 ETH_MACCR_PRELEN_7
@@ -1258,6 +1292,7 @@ typedef struct{ */
/** @defgroup ETH_Source_Addr_Control ETH Source Addr Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_SOURCEADDRESS_DISABLE ((uint32_t)0x00000000U)
@@ -1270,6 +1305,7 @@ typedef struct{ */
/** @defgroup ETH_Control_Packets_Filter ETH Control Packets Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_CTRLPACKETS_BLOCK_ALL ETH_MACPFR_PCF_BLOCKALL
@@ -1281,6 +1317,7 @@ typedef struct{ */
/** @defgroup ETH_VLAN_Tag_Comparison ETH VLAN Tag Comparison
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLANTAGCOMPARISON_16BIT ((uint32_t)0x00000000U)
@@ -1290,6 +1327,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_addresses ETH MAC addresses
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAC_ADDRESS0 ((uint32_t)0x00000000U)
@@ -1301,6 +1339,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Interrupts ETH MAC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_MAC_RX_STATUS_IT ETH_MACIER_RXSTSIE
@@ -1314,6 +1353,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Wake_Up_Event ETH MAC Wake Up Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_WAKEUP_PACKET_RECIEVED ETH_MACPCSR_RWKPRCVD
@@ -1323,6 +1363,7 @@ typedef struct{ */
/** @defgroup ETH_MAC_Rx_Tx_Status ETH MAC Rx Tx Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_RECEIVE_WATCHDOG_TIMEOUT ETH_MACRXTXSR_RWT
@@ -1337,6 +1378,7 @@ typedef struct{ */
/** @defgroup HAL_ETH_StateTypeDef ETH States
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_ETH_STATE_RESET ((uint32_t)0x00000000U) /*!< Peripheral not yet Initialized or disabled */
@@ -1354,6 +1396,7 @@ typedef struct{ /* Exported macro ------------------------------------------------------------*/
/** @defgroup ETH_Exported_Macros ETH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth_ex.h index bb7e0cf3fd..be9a4da0e8 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_eth_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_eth_ex.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup ETHEx_Exported_Types ETHEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -148,10 +149,12 @@ typedef struct{ /* Exported constants --------------------------------------------------------*/
/** @defgroup ETHEx_Exported_Constants ETHEx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ETHEx_LPI_Event ETHEx LPI Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_TX_LPI_ENTRY ETH_MACLCSR_TLPIEN
@@ -163,6 +166,7 @@ typedef struct{ */
/** @defgroup ETHEx_L3_Filter ETHEx L3 Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_FILTER_0 ((uint32_t)0x00000000)
@@ -172,6 +176,7 @@ typedef struct{ */
/** @defgroup ETHEx_L4_Filter ETHEx L4 Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_FILTER_0 ((uint32_t)0x00000000)
@@ -181,6 +186,7 @@ typedef struct{ */
/** @defgroup ETHEx_L3_Protocol ETHEx L3 Protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_IPV6_MATCH ETH_MACL3L4CR_L3PEN
@@ -190,6 +196,7 @@ typedef struct{ */
/** @defgroup ETHEx_L3_Source_Match ETHEx L3 Source Match
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_SRC_ADDR_PERFECT_MATCH_ENABLE ETH_MACL3L4CR_L3SAM
@@ -200,6 +207,7 @@ typedef struct{ */
/** @defgroup ETHEx_L3_Destination_Match ETHEx L3 Destination Match
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L3_DEST_ADDR_PERFECT_MATCH_ENABLE ETH_MACL3L4CR_L3DAM
@@ -210,6 +218,7 @@ typedef struct{ */
/** @defgroup ETHEx_L4_Protocol ETHEx L4 Protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_UDP_MATCH ETH_MACL3L4CR_L4PEN
@@ -219,6 +228,7 @@ typedef struct{ */
/** @defgroup ETHEx_L4_Source_Match ETHEx L4 Source Match
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_SRC_PORT_PERFECT_MATCH_ENABLE ETH_MACL3L4CR_L4SPM
@@ -229,6 +239,7 @@ typedef struct{ */
/** @defgroup ETHEx_L4_Destination_Match ETHEx L4 Destination Match
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_L4_DEST_PORT_PERFECT_MATCH_ENABLE ETH_MACL3L4CR_L4DPM
@@ -239,6 +250,7 @@ typedef struct{ */
/** @defgroup ETHEx_Rx_Inner_VLAN_Tag_Stripping ETHEx Rx Inner VLAN Tag Stripping
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INNERVLANTAGRXSTRIPPING_NONE ETH_MACVTR_EIVLS_DONOTSTRIP
@@ -250,6 +262,7 @@ typedef struct{ */
/** @defgroup ETHEx_Rx_VLAN_Tag_Stripping ETHEx Rx VLAN Tag Stripping
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLANTAGRXSTRIPPING_NONE ETH_MACVTR_EVLS_DONOTSTRIP
@@ -261,6 +274,7 @@ typedef struct{ */
/** @defgroup ETHEx_VLAN_Type_Check ETHEx VLAN Type Check
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLANTYPECHECK_DISABLE ETH_MACVTR_DOVLTC
@@ -271,6 +285,7 @@ typedef struct{ */
/** @defgroup ETHEx_VLAN_Tag_Control ETHEx_VLAN_Tag_Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_VLANTAGCONTROL_NONE (ETH_MACVIR_VLP | ETH_MACVIR_VLC_NOVLANTAG)
@@ -282,6 +297,7 @@ typedef struct{ */
/** @defgroup ETHEx_Tx_VLAN_Tag ETHEx Tx VLAN Tag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define ETH_INNER_TX_VLANTAG ((uint32_t)0x00000001U)
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_exti.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_exti.h index 6273f3c347..2c05d4e575 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_exti.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_exti.h @@ -33,6 +33,7 @@ extern "C" { */
/** @defgroup EXTI EXTI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief EXTI HAL module driver
* @{
*/
@@ -40,6 +41,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup EXTI_Exported_Types EXTI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -84,10 +86,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup EXTI_Exported_Constants EXTI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup EXTI_Line EXTI Line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EXTI_LINE_0 (EXTI_GPIO | EXTI_EVENT | EXTI_REG1 | EXTI_TARGET_MSK_ALL | 0x00U)
@@ -233,6 +237,7 @@ typedef struct */
/** @defgroup EXTI_Mode EXTI Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EXTI_MODE_NONE 0x00000000U
@@ -249,6 +254,7 @@ typedef struct */
/** @defgroup EXTI_Trigger EXTI Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EXTI_TRIGGER_NONE 0x00000000U
@@ -260,6 +266,7 @@ typedef struct */
/** @defgroup EXTI_GPIOSel EXTI GPIOSel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief
* @{
*/
@@ -280,6 +287,7 @@ typedef struct */
/** @defgroup EXTI_PendClear_Source EXTI PendClear Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief
* @{
*/
@@ -306,6 +314,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup EXTI_Exported_Macros EXTI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -315,6 +324,7 @@ typedef struct /* Private constants --------------------------------------------------------*/
/** @defgroup EXTI_Private_Constants EXTI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -390,6 +400,7 @@ typedef struct /* Private macros ------------------------------------------------------------*/
/** @defgroup EXTI_Private_Macros EXTI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_EXTI_PROPERTY(__LINE__) ((((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT) || \
@@ -454,11 +465,13 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup EXTI_Exported_Functions EXTI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief EXTI Exported Functions
* @{
*/
/** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Configuration functions
* @{
*/
@@ -473,6 +486,7 @@ HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLin */
/** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions
* @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_fdcan.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_fdcan.h index cfe58cf7c9..4228ef0d06 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_fdcan.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_fdcan.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup FDCAN_Exported_Types FDCAN Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -790,10 +791,12 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan /* Exported constants --------------------------------------------------------*/
/** @defgroup FDCAN_Exported_Constants FDCAN Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HAL_FDCAN_Error_Code HAL FDCAN Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_FDCAN_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -830,6 +833,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_frame_format FDCAN Frame Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_FRAME_CLASSIC ((uint32_t)0x00000000U) /*!< Classic mode */
@@ -840,6 +844,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_operating_mode FDCAN Operating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_MODE_NORMAL ((uint32_t)0x00000000U) /*!< Normal mode */
@@ -852,6 +857,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_clock_calibration FDCAN Clock Calibration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CLOCK_CALIBRATION_DISABLE ((uint32_t)0x00000000U) /*!< Disable Clock Calibration */
@@ -861,6 +867,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_clock_divider FDCAN Clock Divider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CLOCK_DIV1 ((uint32_t)0x00000000U) /*!< Divide kernel clock by 1 */
@@ -884,6 +891,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_calibration_field_length FDCAN Calibration Field Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CALIB_FIELD_LENGTH_32 ((uint32_t)0x00000000U) /*!< Calibration field length is 32 bits */
@@ -893,6 +901,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_calibration_state FDCAN Calibration State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CLOCK_NOT_CALIBRATED ((uint32_t)0x00000000U) /*!< Clock not calibrated */
@@ -903,6 +912,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_calibration_counter FDCAN Calibration Counter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CALIB_TIME_QUANTA_COUNTER ((uint32_t)0x00000000U) /*!< Time Quanta Counter */
@@ -913,6 +923,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_data_field_size FDCAN Data Field Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_DATA_BYTES_8 ((uint32_t)0x00000004U) /*!< 8 bytes data field */
@@ -928,6 +939,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_txFifoQueue_Mode FDCAN Tx FIFO/Queue Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TX_FIFO_OPERATION ((uint32_t)0x00000000U) /*!< FIFO mode */
@@ -937,6 +949,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_id_type FDCAN ID Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_STANDARD_ID ((uint32_t)0x00000000U) /*!< Standard ID element */
@@ -946,6 +959,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_frame_type FDCAN Frame Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_DATA_FRAME ((uint32_t)0x00000000U) /*!< Data frame */
@@ -955,6 +969,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_data_length_code FDCAN Data Length Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_DLC_BYTES_0 ((uint32_t)0x00000000U) /*!< 0 bytes data field */
@@ -978,6 +993,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_error_state_indicator FDCAN Error State Indicator
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_ESI_ACTIVE ((uint32_t)0x00000000U) /*!< Transmitting node is error active */
@@ -987,6 +1003,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_bit_rate_switching FDCAN Bit Rate Switching
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_BRS_OFF ((uint32_t)0x00000000U) /*!< FDCAN frames transmitted/received without bit rate switching */
@@ -996,6 +1013,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_format FDCAN format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CLASSIC_CAN ((uint32_t)0x00000000U) /*!< Frame transmitted/received in Classic CAN format */
@@ -1005,6 +1023,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_EFC FDCAN Event FIFO control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_NO_TX_EVENTS ((uint32_t)0x00000000U) /*!< Do not store Tx events */
@@ -1014,6 +1033,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_filter_type FDCAN Filter Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_FILTER_RANGE ((uint32_t)0x00000000U) /*!< Range filter from FilterID1 to FilterID2 */
@@ -1025,6 +1045,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_filter_config FDCAN Filter Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_FILTER_DISABLE ((uint32_t)0x00000000U) /*!< Disable filter element */
@@ -1040,6 +1061,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Tx_location FDCAN Tx Location
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TX_BUFFER0 ((uint32_t)0x00000001U) /*!< Add message to Tx Buffer 0 */
@@ -1079,6 +1101,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Rx_location FDCAN Rx Location
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_RX_FIFO0 ((uint32_t)0x00000040U) /*!< Get received message from Rx FIFO 0 */
@@ -1152,6 +1175,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_event_type FDCAN Event Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TX_EVENT ((uint32_t)0x00400000U) /*!< Tx event */
@@ -1161,6 +1185,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_hp_msg_storage FDCAN High Priority Message Storage
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_HP_STORAGE_NO_FIFO ((uint32_t)0x00000000U) /*!< No FIFO selected */
@@ -1172,6 +1197,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_protocol_error_code FDCAN protocol error code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_PROTOCOL_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error occurred */
@@ -1187,6 +1213,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_communication_state FDCAN communication state
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_COM_STATE_SYNC ((uint32_t)0x00000000U) /*!< Node is synchronizing on CAN communication */
@@ -1198,6 +1225,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_FIFO_watermark FDCAN FIFO watermark
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_CFG_TX_EVENT_FIFO ((uint32_t)0x00000000U) /*!< Tx event FIFO */
@@ -1208,6 +1236,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Rx_FIFO_operation_mode FDCAN FIFO operation mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_RX_FIFO_BLOCKING ((uint32_t)0x00000000U) /*!< Rx FIFO blocking mode */
@@ -1217,6 +1246,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Non_Matching_Frames FDCAN non-matching frames
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_ACCEPT_IN_RX_FIFO0 ((uint32_t)0x00000000U) /*!< Accept in Rx FIFO 0 */
@@ -1227,6 +1257,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Reject_Remote_Frames FDCAN reject remote frames
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_FILTER_REMOTE ((uint32_t)0x00000000U) /*!< Filter remote frames */
@@ -1236,6 +1267,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Interrupt_Line FDCAN interrupt line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_INTERRUPT_LINE0 ((uint32_t)0x00000001U) /*!< Interrupt Line 0 */
@@ -1245,6 +1277,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Timestamp FDCAN timestamp
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TIMESTAMP_INTERNAL ((uint32_t)0x00000001U) /*!< Timestamp counter value incremented according to TCP */
@@ -1254,6 +1287,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Timestamp_Prescaler FDCAN timestamp prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TIMESTAMP_PRESC_1 ((uint32_t)0x00000000U) /*!< Timestamp counter time unit in equal to CAN bit time */
@@ -1277,6 +1311,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Timeout_Operation FDCAN timeout operation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TIMEOUT_CONTINUOUS ((uint32_t)0x00000000U) /*!< Timeout continuous operation */
@@ -1288,6 +1323,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_Reference_Message_Payload FDCAN TT reference message payload
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_REF_MESSAGE_NO_PAYLOAD ((uint32_t)0x00000000U) /*!< Reference message has no additional payload */
@@ -1297,6 +1333,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_Repeat_Factor FDCAN TT repeat factor
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_REPEAT_EVERY_CYCLE ((uint32_t)0x00000000U) /*!< Trigger valid for all cycles */
@@ -1311,6 +1348,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_Trigger_Type FDCAN TT trigger type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_TX_REF_TRIGGER ((uint32_t)0x00000000U) /*!< Transmit reference message in strictly time-triggered operation */
@@ -1329,6 +1367,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_Time_Mark_Event_Internal FDCAN TT time mark event internal
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_TM_NO_INTERNAL_EVENT ((uint32_t)0x00000000U) /*!< No action */
@@ -1338,6 +1377,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_Time_Mark_Event_External FDCAN TT time mark event external
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_TM_NO_EXTERNAL_EVENT ((uint32_t)0x00000000U) /*!< No action */
@@ -1347,6 +1387,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_operation_mode FDCAN Operation Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_COMMUNICATION_LEVEL1 ((uint32_t)0x00000001U) /*!< Time triggered communication, level 1 */
@@ -1357,6 +1398,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_operation FDCAN TT Operation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_STRICTLY_TT_OPERATION ((uint32_t)0x00000000U) /*!< Strictly time-triggered operation */
@@ -1366,6 +1408,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_time_master FDCAN TT Time Master
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_SLAVE ((uint32_t)0x00000000U) /*!< Time slave */
@@ -1375,6 +1418,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_external_clk_sync FDCAN TT External Clock Synchronization
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_EXT_CLK_SYNC_DISABLE ((uint32_t)0x00000000U) /*!< External clock synchronization in Level 0,2 disabled */
@@ -1384,6 +1428,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_global_time_filtering FDCAN TT Global Time Filtering
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_GLOB_TIME_FILT_DISABLE ((uint32_t)0x00000000U) /*!< Global time filtering in Level 0,2 disabled */
@@ -1393,6 +1438,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_auto_clk_calibration FDCAN TT Automatic Clock Calibration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_AUTO_CLK_CALIB_DISABLE ((uint32_t)0x00000000U) /*!< Automatic clock calibration in Level 0,2 disabled */
@@ -1402,6 +1448,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_event_trig_polarity FDCAN TT Event Trigger Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_EVT_TRIG_POL_RISING ((uint32_t)0x00000000U) /*!< Rising edge trigger */
@@ -1411,6 +1458,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_basic_cycle_number FDCAN TT Basic Cycle Number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_CYCLES_PER_MATRIX_1 ((uint32_t)0x00000000U) /*!< 1 Basic Cycle per Matrix */
@@ -1425,6 +1473,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_cycle_start_sync FDCAN TT Cycle Start Sync
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_NO_SYNC_PULSE ((uint32_t)0x00000000U) /*!< No sync pulse */
@@ -1435,6 +1484,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_stop_watch_trig_selection FDCAN TT Stop Watch Trigger Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_STOP_WATCH_TRIGGER_0 ((uint32_t)0x00000000U) /*!< TIM2 selected as stop watch trigger */
@@ -1446,6 +1496,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_event_trig_selection FDCAN TT Event Trigger Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_EVENT_TRIGGER_0 ((uint32_t)0x00000000U) /*!< TIM2 selected as event trigger */
@@ -1457,6 +1508,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_stop_watch_source FDCAN TT Stop Watch Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_STOP_WATCH_DISABLED ((uint32_t)0x00000000U) /*!< Stop Watch disabled */
@@ -1468,6 +1520,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_stop_watch_polarity FDCAN TT Stop Watch Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_STOP_WATCH_RISING ((uint32_t)0x00000000U) /*!< Selected stop watch source is captured at rising edge of fdcan1_swt */
@@ -1477,6 +1530,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_time_mark_source FDCAN TT Time Mark Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_REG_TIMEMARK_DIABLED ((uint32_t)0x00000000U) /*!< No Register Time Mark Interrupt generated */
@@ -1488,6 +1542,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_error_level FDCAN TT Error Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_NO_ERROR ((uint32_t)0x00000000U) /*!< Severity 0 - No Error */
@@ -1499,6 +1554,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_master_state FDCAN TT Master State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_MASTER_OFF ((uint32_t)0x00000000U) /*!< Master_Off, no master properties relevant */
@@ -1510,6 +1566,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TT_sync_state FDCAN TT Synchronization State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_OUT_OF_SYNC ((uint32_t)0x00000000U) /*!< Out of Synchronization */
@@ -1521,6 +1578,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup Interrupt_Masks Interrupt masks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IR_MASK ((uint32_t)0x3FCFFFFFU) /*!< FDCAN interrupts mask */
@@ -1530,6 +1588,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_flags FDCAN Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_FLAG_TX_COMPLETE FDCAN_IR_TC /*!< Transmission Completed */
@@ -1567,10 +1626,12 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Interrupts FDCAN Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FDCAN_Tx_Interrupts FDCAN Tx Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_TX_COMPLETE FDCAN_IE_TCE /*!< Transmission Completed */
@@ -1581,6 +1642,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Rx_Interrupts FDCAN Rx Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_RX_HIGH_PRIORITY_MSG FDCAN_IE_HPME /*!< High priority message received */
@@ -1590,6 +1652,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Counter_Interrupts FDCAN Counter Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_TIMESTAMP_WRAPAROUND FDCAN_IE_TSWE /*!< Timestamp counter wrapped around */
@@ -1599,6 +1662,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Clock_Calibration_Interrupts Clock Calibration Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_CALIB_STATE_CHANGED (FDCANCCU_IE_CSCE << 30) /*!< Clock calibration state changed */
@@ -1608,6 +1672,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Tx_Event_Fifo_Interrupts FDCAN Tx Event FIFO Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_TX_EVT_FIFO_ELT_LOST FDCAN_IE_TEFLE /*!< Tx Event FIFO element lost */
@@ -1619,6 +1684,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Rx_Fifo0_Interrupts FDCAN Rx FIFO 0 Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_RX_FIFO0_MESSAGE_LOST FDCAN_IE_RF0LE /*!< Rx FIFO 0 message lost */
@@ -1630,6 +1696,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Rx_Fifo1_Interrupts FDCAN Rx FIFO 1 Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_RX_FIFO1_MESSAGE_LOST FDCAN_IE_RF1LE /*!< Rx FIFO 1 message lost */
@@ -1641,6 +1708,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Error_Interrupts FDCAN Error Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_RAM_ACCESS_FAILURE FDCAN_IE_MRAFE /*!< Message RAM access failure occurred */
@@ -1654,6 +1722,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_Error_Status_Interrupts FDCAN Error Status Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_IT_ERROR_PASSIVE FDCAN_IE_EPE /*!< Error_Passive status changed */
@@ -1668,6 +1737,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTflags FDCAN TT Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_FLAG_BASIC_CYCLE_START FDCAN_TTIR_SBC /*!< Start of Basic Cycle */
@@ -1694,10 +1764,12 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTInterrupts FDCAN TT Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FDCAN_TTScheduleSynchronization_Interrupts FDCAN TT Schedule Synchronization Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_BASIC_CYCLE_START FDCAN_TTIE_SBCE /*!< Start of Basic Cycle */
@@ -1709,6 +1781,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTTimeMark_Interrupts FDCAN TT Time Mark Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_REG_TIME_MARK FDCAN_TTIE_RTMIE /*!< Register Time Mark Interrupt */
@@ -1718,6 +1791,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTStopWatch_Interrupt FDCAN TT Stop Watch Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_STOP_WATCH FDCAN_TTIE_SWEE /*!< Stop Watch Event */
@@ -1726,6 +1800,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTGlobalTime_Interrupts FDCAN TT Global Time Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_GLOBAL_TIME_WRAP FDCAN_TTIE_GTWE /*!< Global Time Wrap */
@@ -1735,6 +1810,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTDisturbingError_Interrupts FDCAN TT Disturbing Error Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_GLOBAL_TIME_ERROR FDCAN_TTIE_GTEE /*!< Global Time Error */
@@ -1748,6 +1824,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan */
/** @defgroup FDCAN_TTFatalError_Interrupts FDCAN TT Fatal Error Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FDCAN_TT_IT_INIT_WATCH_TRIGGER FDCAN_TTIE_IWTE /*!< Initialization Watch Trigger */
@@ -1768,6 +1845,7 @@ typedef void (*pFDCAN_TT_GlobalTimeCallbackTypeDef)(FDCAN_HandleTypeDef *hfdcan /* Exported macro ------------------------------------------------------------*/
/** @defgroup FDCAN_Exported_Macros FDCAN Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2123,6 +2201,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private types -------------------------------------------------------------*/
/** @defgroup FDCAN_Private_Types FDCAN Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2132,6 +2211,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private variables ---------------------------------------------------------*/
/** @defgroup FDCAN_Private_Variables FDCAN Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2141,6 +2221,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private constants ---------------------------------------------------------*/
/** @defgroup FDCAN_Private_Constants FDCAN Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2150,6 +2231,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private macros ------------------------------------------------------------*/
/** @defgroup FDCAN_Private_Macros FDCAN Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_FDCAN_FRAME_FORMAT(FORMAT) (((FORMAT) == FDCAN_FRAME_CLASSIC ) || \
@@ -2381,6 +2463,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup FDCAN_Private_Functions_Prototypes FDCAN Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2390,6 +2473,7 @@ HAL_FDCAN_StateTypeDef HAL_FDCAN_GetState(FDCAN_HandleTypeDef *hfdcan); /* Private functions ---------------------------------------------------------*/
/** @defgroup FDCAN_Private_Functions FDCAN Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_flash.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_flash.h index 6bda249e22..eb83462180 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_flash.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_flash.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup FLASH_Exported_Types FLASH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -84,10 +85,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup FLASH_Exported_Constants FLASH Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FLASH_Error_Code FLASH Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FLASH Error Code
* @{
*/
@@ -138,6 +141,7 @@ typedef struct */
/** @defgroup FLASH_Type_Program FLASH Type Program
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_TYPEPROGRAM_FLASHWORD 0x01U /*!< Program a flash word at a specified address */
@@ -149,6 +153,7 @@ typedef struct */
/** @defgroup FLASH_Flag_definition FLASH Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flag definition
* @{
*/
@@ -251,6 +256,7 @@ typedef struct */
/** @defgroup FLASH_Interrupt_definition FLASH Interrupt definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief FLASH Interrupt definition
* @{
*/
@@ -321,6 +327,7 @@ typedef struct #if defined (FLASH_CR_PSIZE)
/** @defgroup FLASH_Program_Parallelism FLASH Program Parallelism
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_PSIZE_BYTE 0x00000000U /*!< Flash program/erase by 8 bits */
@@ -334,6 +341,7 @@ typedef struct /** @defgroup FLASH_Keys FLASH Keys
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_KEY1 0x45670123U
@@ -345,6 +353,7 @@ typedef struct */
/** @defgroup FLASH_Sectors FLASH Sectors
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_SECTOR_0 0U /*!< Sector Number 0 */
@@ -487,6 +496,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup FLASH_Exported_Macros FLASH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -740,6 +750,7 @@ uint32_t HAL_FLASH_GetError(void); /* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup FLASH_Private_Variables FLASH Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
extern FLASH_ProcessTypeDef pFlash;
@@ -748,6 +759,7 @@ extern FLASH_ProcessTypeDef pFlash; */
/* Private constants ---------------------------------------------------------*/
/** @defgroup FLASH_Private_Constants FLASH Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -757,6 +769,7 @@ extern FLASH_ProcessTypeDef pFlash; /* Private macros ------------------------------------------------------------*/
/** @defgroup FLASH_Private_Macros FLASH Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -803,6 +816,7 @@ extern FLASH_ProcessTypeDef pFlash; */
/* Private functions ---------------------------------------------------------*/
/** @defgroup FLASH_Private_Functions FLASH Private functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout, uint32_t Bank);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_flash_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_flash_ex.h index 834c5d23fb..e411dbed62 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_flash_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_flash_ex.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup FLASHEx_Exported_Types FLASH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -174,10 +175,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup FLASHEx_Exported_Constants FLASH Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FLASHEx_Type_Erase FLASH Type Erase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_TYPEERASE_SECTORS 0x00U /*!< Sectors erase only */
@@ -188,6 +191,7 @@ typedef struct #if defined (FLASH_CR_PSIZE)
/** @defgroup FLASHEx_Voltage_Range FLASH Voltage Range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_VOLTAGE_RANGE_1 0x00000000U /*!< Flash program/erase by 8 bits */
@@ -200,6 +204,7 @@ typedef struct #endif /* FLASH_CR_PSIZE */
/** @defgroup FLASHEx_WRP_State FLASH WRP State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_WRPSTATE_DISABLE 0x00000000U /*!< Disable the write protection of the desired bank 1 sectors */
@@ -209,6 +214,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Type FLASH Option Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OPTIONBYTE_WRP 0x01U /*!< WRP option byte configuration */
@@ -232,6 +238,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_Read_Protection FLASH Option Bytes Read Protection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_RDP_LEVEL_0 0xAA00U
@@ -243,6 +250,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_WWatchdog FLASH Option Bytes WWatchdog
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_WWDG_SW 0x10U /*!< Software WWDG selected */
@@ -253,6 +261,7 @@ typedef struct /** @defgroup FLASHEx_Option_Bytes_IWatchdog FLASH Option Bytes IWatchdog
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IWDG_SW 0x20U /*!< Software IWDG selected */
@@ -262,6 +271,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_nRST_STOP FLASH Option Bytes nRST_STOP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STOP_NO_RST 0x40U /*!< No reset generated when entering in STOP */
@@ -271,6 +281,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_nRST_STDBY FLASH Option Bytes nRST_STDBY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STDBY_NO_RST 0x80U /*!< No reset generated when entering in STANDBY */
@@ -280,6 +291,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_IWDG_FREEZE_STOP FLASH IWDG Counter Freeze in STOP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IWDG_STOP_FREEZE 0x00000000U /*!< Freeze IWDG counter in STOP mode */
@@ -289,6 +301,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_IWDG_FREEZE_SANDBY FLASH IWDG Counter Freeze in STANDBY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IWDG_STDBY_FREEZE 0x00000000U /*!< Freeze IWDG counter in STANDBY mode */
@@ -298,6 +311,7 @@ typedef struct */
/** @defgroup FLASHEx_BOR_Reset_Level FLASH BOR Reset Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_BOR_LEVEL0 0x00000000U /*!< Reset level threshold is set to 1.6V */
@@ -311,6 +325,7 @@ typedef struct /** @defgroup FLASHEx_Boot_Address FLASH Boot Address
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_BOOTADDR_ITCM_RAM 0x0000U /*!< Boot from ITCM RAM (0x00000000) */
@@ -325,6 +340,7 @@ typedef struct */
/** @defgroup FLASH_Latency FLASH Latency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_LATENCY_0 FLASH_ACR_LATENCY_0WS /*!< FLASH Zero Latency cycle */
@@ -348,6 +364,7 @@ typedef struct */
/** @defgroup FLASHEx_Banks FLASH Banks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_BANK_1 0x01U /*!< Bank 1 */
@@ -358,6 +375,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_PCROP_RDP FLASHEx OB PCROP RDP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_PCROP_RDP_NOT_ERASE 0x00000000U /*!< PCROP area is not erased when the RDP level
@@ -370,6 +388,7 @@ typedef struct */
/** @defgroup FLASHEx_Option_Bytes_Write_Protection FLASH Option Bytes Write Protection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (FLASH_SECTOR_TOTAL == 128)
@@ -422,6 +441,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_SECURITY FLASHEx OB SECURITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_SECURITY_DISABLE 0x00000000U /*!< security enabled */
@@ -431,6 +451,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_ST_RAM_SIZE FLASHEx OB ST RAM SIZE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_ST_RAM_SIZE_2KB 0x00000000U /*!< 2 Kbytes reserved to ST code */
@@ -443,6 +464,7 @@ typedef struct #if defined(DUAL_CORE)
/** @defgroup FLASHEx_OB_BCM7 FLASHEx OB BCM7
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_BCM7_DISABLE 0x00000000U /*!< CM7 Boot disabled */
@@ -453,6 +475,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_BCM4 FLASHEx OB BCM4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_BCM4_DISABLE 0x00000000U /*!< CM4 Boot disabled */
@@ -463,6 +486,7 @@ typedef struct #endif /* DUAL_CORE */
/** @defgroup FLASHEx_OB_IWDG1_SW FLASHEx OB IWDG1 SW
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IWDG1_SW FLASH_OPTSR_IWDG1_SW /*!< Hardware independent watchdog 1 */
@@ -473,6 +497,7 @@ typedef struct #if defined(DUAL_CORE)
/** @defgroup FLASHEx_OB_IWDG2_SW FLASHEx OB IWDG2 SW
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IWDG2_SW FLASH_OPTSR_IWDG2_SW /*!< Hardware independent watchdog 2*/
@@ -483,6 +508,7 @@ typedef struct #endif
/** @defgroup FLASHEx_OB_NRST_STOP_D1 FLASHEx OB NRST STOP D1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STOP_RST_D1 0x00000000U /*!< Reset generated when entering the D1 to stop mode */
@@ -492,6 +518,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_NRST_STDBY_D1 FLASHEx OB NRST STDBY D1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STDBY_RST_D1 0x00000000U /*!< Reset generated when entering the D1 to standby mode */
@@ -502,6 +529,7 @@ typedef struct #if defined (DUAL_CORE)
/** @defgroup FLASHEx_OB_NRST_STOP_D2 FLASHEx OB NRST STOP D2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STOP_RST_D2 0x00000000U /*!< Reset generated when entering the D2 to stop mode */
@@ -511,6 +539,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_NRST_STDBY_D2 FLASHEx OB NRST STDBY D2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_STDBY_RST_D2 0x00000000U /*!< Reset generated when entering the D2 to standby mode */
@@ -521,6 +550,7 @@ typedef struct #endif /* DUAL_CORE */
/** @defgroup FLASHEx_OB_SWAP_BANK FLASHEx OB SWAP BANK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_SWAP_BANK_DISABLE 0x00000000U /*!< Bank swap disabled */
@@ -530,6 +560,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_IOHSLV FLASHEx OB IOHSLV
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_IOHSLV_DISABLE 0x00000000U /*!< IOHSLV disabled */
@@ -540,6 +571,7 @@ typedef struct #if defined (FLASH_OPTSR_VDDMMC_HSLV)
/** @defgroup FLASHEx_OB_VDDMMC_HSLV FLASHEx OB VDDMMC HSLV
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_VDDMMC_HSLV_DISABLE 0x00000000U /*!< VDDMMC HSLV disabled */
@@ -550,6 +582,7 @@ typedef struct #endif /* FLASH_OPTSR_VDDMMC_HSLV */
/** @defgroup FLASHEx_OB_BOOT_OPTION FLASHEx OB BOOT OPTION
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_BOOT_ADD0 0x01U /*!< Select Boot Address 0 */
@@ -560,6 +593,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_USER_Type FLASHEx OB USER Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_USER_IWDG1_SW 0x0001U /*!< Independent watchdog selection */
@@ -587,6 +621,7 @@ typedef struct */
/** @defgroup FLASHEx_OB_SECURE_RDP FLASHEx OB SECURE RDP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OB_SECURE_RDP_NOT_ERASE 0x00000000U /*!< Secure area is not erased when the RDP level
@@ -598,6 +633,7 @@ typedef struct */
/** @defgroup FLASHEx_CRC_Selection_Type FLASH CRC Selection Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_CRC_ADDR 0x00000000U /*!< CRC selection type by address */
@@ -608,6 +644,7 @@ typedef struct */
/** @defgroup FLASHEx_CRC_Burst_Size FLASH CRC Burst Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_CRC_BURST_SIZE_4 0x00000000U /*!< Every burst has a size of 4 Flash words (256-bit) */
@@ -619,6 +656,7 @@ typedef struct */
/** @defgroup FLASHEx_Programming_Delay FLASH Programming Delay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_PROGRAMMING_DELAY_0 0x00000000U /*!< programming delay set for Flash running at 70 MHz or below */
@@ -631,6 +669,7 @@ typedef struct #if defined (FLASH_OTPBL_LOCKBL)
/** @defgroup FLASHEx_OTP_Blocks FLASH OTP blocks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FLASH_OTP_BLOCK_0 0x00000001U /*!< OTP Block0 */
@@ -657,6 +696,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup FLASHEx_Exported_Macros FLASH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -741,10 +781,12 @@ HAL_StatusTypeDef HAL_FLASHEx_ComputeCRC(FLASH_CRCInitTypeDef *pCRCInit, uint32_ /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup FLASHEx_Private_Macros FLASHEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FLASHEx_IS_FLASH_Definitions FLASHEx Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -882,6 +924,7 @@ HAL_StatusTypeDef HAL_FLASHEx_ComputeCRC(FLASH_CRCInitTypeDef *pCRCInit, uint32_ /* Private functions ---------------------------------------------------------*/
/** @defgroup FLASHEx_Private_Functions FLASHEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void FLASH_Erase_Sector(uint32_t Sector, uint32_t Banks, uint32_t VoltageRange);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_gfxmmu.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_gfxmmu.h index 2d41105dce..47c179ea23 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_gfxmmu.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_gfxmmu.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup GFXMMU_Exported_Types GFXMMU Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -173,10 +174,12 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); /* Exported constants --------------------------------------------------------*/
/** @defgroup GFXMMU_Exported_Constants GFXMMU Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GFXMMU_BlocksPerLine GFXMMU blocks per line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_256BLOCKS 0x00000000U /*!< 256 blocks of 16 bytes per line */
@@ -186,6 +189,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_CacheLock GFXMMU cache lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_CACHE_LOCK_DISABLE 0x00000000U /*!< Cache not locked to a buffer */
@@ -195,6 +199,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_CacheLockBuffer GFXMMU cache lock buffer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_CACHE_LOCK_BUFFER0 0x00000000U /*!< Cache locked to buffer 0 */
@@ -206,6 +211,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_CacheForce GFXMMU cache force
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_CACHE_FORCE_DISABLE 0x00000000U /*!< Caching not forced */
@@ -215,6 +221,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_OutterBufferability GFXMMU outter bufferability
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_OUTTER_BUFFERABILITY_DISABLE 0x00000000U /*!< No bufferable */
@@ -224,6 +231,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_OutterCachability GFXMMU outter cachability
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_OUTTER_CACHABILITY_DISABLE 0x00000000U /*!< No cachable */
@@ -233,6 +241,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_Prefetch GFXMMU pre-fetch
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_PREFETCH_DISABLE GFXMMU_CR_PD /*!< Pre-fetch disable */
@@ -242,6 +251,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_Interrupts GFXMMU interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_AHB_MASTER_ERROR_IT GFXMMU_CR_AMEIE /*!< AHB master error interrupt */
@@ -254,6 +264,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_Error_Code GFXMMU Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_ERROR_NONE 0x00000000U /*!< No error */
@@ -270,6 +281,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_LutLineStatus GFXMMU LUT line status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_LUT_LINE_DISABLE 0x00000000U /*!< LUT line disabled */
@@ -279,6 +291,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_CacheForceParam GFXMMU cache force parameter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GFXMMU_CACHE_FORCE_FLUSH GFXMMU_CCR_FF /*!< Force cache flush */
@@ -294,6 +307,7 @@ typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu); /* Exported macros -----------------------------------------------------------*/
/** @defgroup GFXMMU_Exported_Macros GFXMMU Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -371,6 +385,7 @@ void HAL_GFXMMU_ErrorCallback(GFXMMU_HandleTypeDef *hgfxmmu); */
/** @defgroup GFXMMU_Exported_Functions_Group3 State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* State function *************************************************************/
@@ -388,6 +403,7 @@ uint32_t HAL_GFXMMU_GetError(GFXMMU_HandleTypeDef *hgfxmmu); /* Private macros ------------------------------------------------------------*/
/** @defgroup GFXMMU_Private_Macros GFXMMU Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_GFXMMU_BLOCKS_PER_LINE(VALUE) (((VALUE) == GFXMMU_256BLOCKS) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio.h index f7f6eecea1..4e164817f4 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup GPIO_Exported_Types GPIO Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -77,10 +78,12 @@ typedef enum /* Exported constants --------------------------------------------------------*/
/** @defgroup GPIO_Exported_Constants GPIO Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_pins_define GPIO pins define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */
@@ -107,6 +110,7 @@ typedef enum */
/** @defgroup GPIO_mode_define GPIO mode define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GPIO Configuration Mode
* Elements values convention: 0xX0yz00YZ
* - X : GPIO mode or EXTI Mode
@@ -136,6 +140,7 @@ typedef enum */
/** @defgroup GPIO_speed_define GPIO speed define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GPIO Output Maximum frequency
* @{
*/
@@ -148,6 +153,7 @@ typedef enum */
/** @defgroup GPIO_pull_define GPIO pull define
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief GPIO Pull-Up or Pull-Down Activation
* @{
*/
@@ -164,6 +170,7 @@ typedef enum /* Exported macro ------------------------------------------------------------*/
/** @defgroup GPIO_Exported_Macros GPIO Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -284,6 +291,7 @@ void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup GPIO_Private_Constants GPIO Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -293,6 +301,7 @@ void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); /* Private macros ------------------------------------------------------------*/
/** @defgroup GPIO_Private_Macros GPIO Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
@@ -322,6 +331,7 @@ void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); /* Private functions ---------------------------------------------------------*/
/** @defgroup GPIO_Private_Functions GPIO Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio_ex.h index ff2efb3c07..597d6c20c9 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_gpio_ex.h @@ -40,10 +40,12 @@ extern "C" { /* Exported constants --------------------------------------------------------*/
/** @defgroup GPIOEx_Exported_Constants GPIO Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_Alternate_function_selection GPIO Alternate Function Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -329,6 +331,7 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup GPIOEx_Exported_Macros GPIO Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -337,6 +340,7 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup GPIOEx_Exported_Functions GPIO Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -346,6 +350,7 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup GPIOEx_Private_Constants GPIO Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -372,9 +377,11 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup GPIOEx_Private_Macros GPIO Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIOEx_Get_Port_Index GPIO Get Port Index
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define GPIO_GET_INDEX(__GPIOx__) (((__GPIOx__) == (GPIOA))? 0UL :\
@@ -392,6 +399,7 @@ extern "C" { */
/** @defgroup GPIOEx_IS_Alternat_function_selection GPIO Check Alternate Function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -404,6 +412,7 @@ extern "C" { /* Private functions ---------------------------------------------------------*/
/** @defgroup GPIOEx_Private_Functions GPIO Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hash.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hash.h index e1782379ac..3d0d5b8e88 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hash.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hash.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup HASH_Exported_Types HASH Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -182,10 +183,12 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup HASH_Exported_Constants HASH Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HASH_Algo_Selection HASH algorithm selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_ALGOSELECTION_SHA1 0x00000000U /*!< HASH function is SHA1 */
@@ -197,6 +200,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_Algorithm_Mode HASH algorithm mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_ALGOMODE_HASH 0x00000000U /*!< Algorithm is HASH */
@@ -206,6 +210,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_Data_Type HASH input data type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_DATATYPE_32B 0x00000000U /*!< 32-bit data. No swapping */
@@ -217,6 +222,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_HMAC_Long_key_only_for_HMAC_mode HMAC key length type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_HMAC_KEYTYPE_SHORTKEY 0x00000000U /*!< HMAC Key size is <= 64 bytes */
@@ -226,6 +232,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_flags_definition HASH flags definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_FLAG_DINIS HASH_SR_DINIS /*!< 16 locations are free in the DIN : a new block can be entered in the Peripheral */
@@ -239,6 +246,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_interrupts_definition HASH interrupts definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HASH_IT_DINI HASH_IMR_DINIE /*!< A new block can be entered into the input buffer (DIN) */
@@ -248,6 +256,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer * @}
*/
/** @defgroup HASH_alias HASH API alias
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_HASHEx_IRQHandler HAL_HASH_IRQHandler /*!< HAL_HASHEx_IRQHandler() is re-directed to HAL_HASH_IRQHandler() for compatibility with legacy code */
@@ -256,6 +265,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer */
/** @defgroup HASH_Error_Definition HASH Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_HASH_ERROR_NONE 0x00000000U /*!< No error */
@@ -274,6 +284,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer /* Exported macros -----------------------------------------------------------*/
/** @defgroup HASH_Exported_Macros HASH Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -382,6 +393,7 @@ typedef void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer /* Private macros --------------------------------------------------------*/
/** @defgroup HASH_Private_Macros HASH Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h index 765f989183..a71882d5a6 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h @@ -39,10 +39,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
@@ -64,6 +66,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)
@@ -102,10 +105,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
@@ -117,6 +122,7 @@ typedef struct */
/** @defgroup HCD_PHY_Module HCD PHY Module
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HCD_PHY_ULPI 1U
@@ -126,6 +132,7 @@ typedef struct */
/** @defgroup HCD_Error_Code_definition HCD Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HCD Error Code definition
* @{
*/
@@ -143,6 +150,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup HCD_Exported_Macros HCD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -168,6 +176,7 @@ typedef struct */
/** @defgroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
@@ -186,6 +195,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
* @{
*/
@@ -206,6 +216,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
* @{
*/
@@ -286,6 +297,7 @@ uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd); /* Private macros ------------------------------------------------------------*/
/** @defgroup HCD_Private_Macros HCD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -295,6 +307,7 @@ uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup HCD_Private_Functions_Prototypes HCD Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -304,6 +317,7 @@ uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd); /* Private functions ---------------------------------------------------------*/
/** @defgroup HCD_Private_Functions HCD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h index 5976853485..5c211a67ae 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h @@ -42,6 +42,7 @@ * @{
*/
/** @defgroup HRTIM_Max_Timer HRTIM Max Timer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MAX_HRTIM_TIMER 6U
@@ -53,6 +54,7 @@ */
/** @defgroup HRTIM_Exported_Types HRTIM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -528,10 +530,12 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< /* Exported constants --------------------------------------------------------*/
/** @defgroup HRTIM_Exported_Constants HRTIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HRTIM_Timer_Index HRTIM Timer Index
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the timer indexes
*/
@@ -547,6 +551,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_identifier HRTIM Timer identifier
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer identifiers
*/
@@ -561,6 +566,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Compare_Unit HRTIM Compare Unit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining compare unit identifiers
*/
@@ -573,6 +579,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Capture_Unit HRTIM Capture Unit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining capture unit identifiers
*/
@@ -583,6 +590,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Output HRTIM Timer Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer output identifiers
*/
@@ -601,6 +609,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_ADC_Trigger HRTIM ADC Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining ADC triggers identifiers
*/
@@ -618,6 +627,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< * @}
*/
/** @defgroup HRTIM_External_Event_Channels HRTIM External Event Channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining external event channel identifiers
*/
@@ -637,6 +647,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Channel HRTIM Fault Channel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining fault channel identifiers
*/
@@ -651,6 +662,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< /** @defgroup HRTIM_Prescaler_Ratio HRTIM Prescaler Ratio
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer high-resolution clock prescaler ratio.
*/
@@ -662,6 +674,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Counter_Operating_Mode HRTIM Counter Operating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer counter operating mode.
*/
@@ -673,6 +686,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Half_Mode_Enable HRTIM Half Mode Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining half mode enabling status.
*/
@@ -683,6 +697,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Start_On_Sync_Input_Event HRTIM Start On Sync Input Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the timer behavior following the synchronization event
*/
@@ -693,6 +708,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Reset_On_Sync_Input_Event HRTIM Reset On Sync Input Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the timer behavior following the synchronization event
*/
@@ -703,6 +719,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_DAC_Synchronization HRTIM DAC Synchronization
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the DAC synchronization event is sent
*/
@@ -715,6 +732,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Register_Preload_Enable HRTIM Register Preload Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether a write access into a preloadable
* register is done into the active or the preload register.
@@ -726,6 +744,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Update_Gating HRTIM Update Gating
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining how the update occurs relatively to the burst DMA
* transaction and the external update request on update enable inputs 1 to 3.
@@ -744,6 +763,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Burst_Mode HRTIM Timer Burst Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining how the timer behaves during a burst
mode operation.
@@ -755,6 +775,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Repetition_Update HRTIM Timer Repetition Update
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether registers are updated when the timer
* repetition period is completed (either due to roll-over or
@@ -768,6 +789,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< /** @defgroup HRTIM_Timer_Push_Pull_Mode HRTIM Timer Push Pull Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the push-pull mode is enabled for
* a timer.
@@ -779,6 +801,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Fault_Enabling HRTIM Timer Fault Enabling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether a fault channel is enabled for a timer
*/
@@ -793,6 +816,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Fault_Lock HRTIM Timer Fault Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not fault enabling bits are write
* protected for a timer
@@ -804,6 +828,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Deadtime_Insertion HRTIM Timer Dead-time Insertion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not fault the dead time insertion
* feature is enabled for a timer
@@ -815,6 +840,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Delayed_Protection_Mode HRTIM Timer Delayed Protection Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining all possible delayed protection modes
* for a timer. Also define the source and outputs on which the delayed
@@ -844,6 +870,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Update_Trigger HRTIM Timer Update Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the registers update is done synchronously
* with any other timer or master update
@@ -860,6 +887,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Reset_Trigger HRTIM Timer Reset Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to trigger the reset
* of the timer counter
@@ -900,6 +928,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_Reset_Update HRTIM Timer Reset Update
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the register are updated upon Timerx
* counter reset or roll-over to 0 after reaching the period value
@@ -912,6 +941,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Compare_Unit_Auto_Delayed_Mode HRTIM Compare Unit Auto Delayed Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the compare register is behaving in
* regular mode (compare match issued as soon as counter equal compare),
@@ -926,6 +956,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Simple_OC_Mode HRTIM Simple OC Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the behavior of the output signal when the timer
operates in basic output compare mode
@@ -943,6 +974,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Polarity HRTIM Output Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of a timer output
*/
@@ -953,6 +985,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Set_Source HRTIM Output Set Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to configure the
* set crossbar of a timer output
@@ -994,6 +1027,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Reset_Source HRTIM Output Reset Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to configure the
* set crossbar of a timer output
@@ -1035,6 +1069,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Idle_Mode HRTIM Output Idle Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the timer output transition to its
IDLE state when burst mode is entered
@@ -1046,6 +1081,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_IDLE_Level HRTIM Output IDLE Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the output level when output is in IDLE state
*/
@@ -1056,6 +1092,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_FAULT_Level HRTIM Output FAULT Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the output level when output is in FAULT state
*/
@@ -1068,6 +1105,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Chopper_Mode_Enable HRTIM Output Chopper Mode Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not chopper mode is enabled for a timer
output
@@ -1079,6 +1117,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Burst_Mode_Entry_Delayed HRTIM Output Burst Mode Entry Delayed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the idle mode entry is delayed by forcing a
dead-time insertion before switching the outputs to their idle state
@@ -1091,6 +1130,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< /** @defgroup HRTIM_Capture_Unit_Trigger HRTIM Capture Unit Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to trigger the
* capture of the timing unit counter
@@ -1132,6 +1172,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_External_Event_Filter HRTIM Timer External Event Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the event filtering applied to external events
* by a timer
@@ -1157,6 +1198,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timer_External_Event_Latch HRTIM Timer External Event Latch
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the external event is
* memorized (latched) and generated as soon as the blanking period
@@ -1169,6 +1211,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Prescaler_Ratio HRTIM Dead-time Prescaler Ratio
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining division ratio between the timer clock frequency
* (fHRTIM) and the dead-time generator clock (fDTG)
@@ -1186,6 +1229,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Rising_Sign HRTIM Dead-time Rising Sign
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the dead-time is positive or negative
* (overlapping signal) on rising edge
@@ -1197,6 +1241,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Rising_Lock HRTIM Dead-time Rising Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the dead-time (rising sign and
* value) is write protected
@@ -1208,6 +1253,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Rising_Sign_Lock HRTIM Dead-time Rising Sign Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the dead-time rising sign is write
* protected
@@ -1219,6 +1265,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Falling_Sign HRTIM Dead-time Falling Sign
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the dead-time is positive or negative
* (overlapping signal) on falling edge
@@ -1230,6 +1277,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Falling_Lock HRTIM Dead-time Falling Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the dead-time (falling sign and
* value) is write protected
@@ -1241,6 +1289,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Deadtime_Falling_Sign_Lock HRTIM Dead-time Falling Sign Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the dead-time falling sign is write
* protected
@@ -1252,6 +1301,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Chopper_Frequency HRTIM Chopper Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the frequency of the generated high frequency carrier
*/
@@ -1276,6 +1326,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Chopper_Duty_Cycle HRTIM Chopper Duty Cycle
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the duty cycle of the generated high frequency carrier
* Duty cycle can be adjusted by 1/8 step (from 0/8 up to 7/8)
@@ -1293,6 +1344,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Chopper_Start_Pulse_Width HRTIM Chopper Start Pulse Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the pulse width of the first pulse of the generated
* high frequency carrier
@@ -1318,6 +1370,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Synchronization_Options HRTIM Synchronization Options
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the options for synchronizing multiple HRTIM
* instances, as a master unit (generating a synchronization signal)
@@ -1331,6 +1384,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Synchronization_Input_Source HRTIM Synchronization Input Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining defining the synchronization input source
*/
@@ -1342,6 +1396,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Synchronization_Output_Source HRTIM Synchronization Output Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the source and event to be sent on the
* synchronization outputs
@@ -1355,6 +1410,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Synchronization_Output_Polarity HRTIM Synchronization Output Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the routing and conditioning of the synchronization output event
*/
@@ -1366,6 +1422,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Sources HRTIM External Event Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining available sources associated to external events
*/
@@ -1378,6 +1435,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Polarity HRTIM External Event Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of an external event
*/
@@ -1388,6 +1446,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Sensitivity HRTIM External Event Sensitivity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the sensitivity (level-sensitive or edge-sensitive)
* of an external event
@@ -1401,6 +1460,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Fast_Mode HRTIM External Event Fast Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not an external event is programmed in
fast mode
@@ -1412,6 +1472,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Filter HRTIM External Event Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the frequency used to sample an external event 6
* input and the length (N) of the digital filter applied
@@ -1437,6 +1498,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Event_Prescaler HRTIM External Event Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining division ratio between the timer clock frequency
* fHRTIM) and the external event signal sampling clock (fEEVS)
@@ -1451,6 +1513,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Sources HRTIM Fault Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether a fault is triggered by any external
* or internal fault source
@@ -1462,6 +1525,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Polarity HRTIM Fault Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of a fault event
*/
@@ -1472,6 +1536,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Filter HRTIM Fault Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @ brief Constants defining the frequency used to sample the fault input and
* the length (N) of the digital filter applied
@@ -1497,6 +1562,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Lock HRTIM Fault Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the fault programming bits are
write protected
@@ -1508,6 +1574,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_External_Fault_Prescaler HRTIM External Fault Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the division ratio between the timer clock
* frequency (fHRTIM) and the fault signal sampling clock (fFLTS) used
@@ -1522,6 +1589,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Operating_Mode HRTIM Burst Mode Operating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining if the burst mode is entered once or if it is
* continuously operating
@@ -1533,6 +1601,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Clock_Source HRTIM Burst Mode Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the clock source for the burst mode counter
*/
@@ -1551,6 +1620,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Prescaler HRTIM Burst Mode Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the prescaling ratio of the fHRTIM clock
* for the burst mode controller
@@ -1576,6 +1646,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Register_Preload_Enable HRTIM Burst Mode Register Preload Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not burst mode registers preload
mechanism is enabled, i.e. a write access into a preloadable register
@@ -1588,6 +1659,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Trigger HRTIM Burst Mode Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be used to trig the burst
* mode operation
@@ -1629,6 +1701,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_ADC_Trigger_Update_Source HRTIM ADC Trigger Update Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief constants defining the source triggering the update of the
HRTIM_ADCxR register (transfer from preload to active register).
@@ -1644,6 +1717,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_ADC_Trigger_Event HRTIM ADC Trigger Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief constants defining the events triggering ADC conversion.
* HRTIM_ADCTRIGGEREVENT13_*: ADC Triggers 1 and 3
@@ -1722,6 +1796,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_DMA_Registers_Update HRTIM Burst DMA Registers Update
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the registers that can be written during a burst
* DMA operation
@@ -1753,6 +1828,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Control HRTIM Burst Mode Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants used to enable or disable the burst mode controller
*/
@@ -1763,6 +1839,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Fault_Mode_Control HRTIM Fault Mode Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants used to enable or disable a fault channel
*/
@@ -1773,6 +1850,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Software_Timer_Update HRTIM Software Timer Update
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants used to force timer registers update
*/
@@ -1787,6 +1865,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Software_Timer_Reset HRTIM Software Timer Reset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants used to force timer counter reset
*/
@@ -1801,6 +1880,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_Level HRTIM Output Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the level of a timer output
*/
@@ -1815,6 +1895,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Output_State HRTIM Output State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the state of a timer output
*/
@@ -1829,6 +1910,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Burst_Mode_Status HRTIM Burst Mode Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the operating state of the burst mode controller
*/
@@ -1839,6 +1921,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Current_Push_Pull_Status HRTIM Current Push Pull Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the signal is currently applied
* in push-pull mode
@@ -1850,6 +1933,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Idle_Push_Pull_Status HRTIM Idle Push Pull Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the signal was applied, in
* push-pull mode balanced fault mode or delayed idle mode, when the
@@ -1862,6 +1946,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Common_Interrupt_Enable HRTIM Common Interrupt Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_IT_NONE 0x00000000U /*!< No interrupt enabled */
@@ -1877,6 +1962,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Master_Interrupt_Enable HRTIM Master Interrupt Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_MASTER_IT_NONE 0x00000000U /*!< No interrupt enabled */
@@ -1892,6 +1978,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timing_Unit_Interrupt_Enable HRTIM Timing Unit Interrupt Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_TIM_IT_NONE 0x00000000U /*!< No interrupt enabled */
@@ -1914,6 +2001,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Common_Interrupt_Flag HRTIM Common Interrupt Flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_FLAG_FLT1 HRTIM_ISR_FLT1 /*!< Fault 1 interrupt flag */
@@ -1928,6 +2016,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Master_Interrupt_Flag HRTIM Master Interrupt Flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_MASTER_FLAG_MCMP1 HRTIM_MISR_MCMP1 /*!< Master compare 1 interrupt flag */
@@ -1942,6 +2031,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timing_Unit_Interrupt_Flag HRTIM Timing Unit Interrupt Flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_TIM_FLAG_CMP1 HRTIM_TIMISR_CMP1 /*!< Timer compare 1 interrupt flag */
@@ -1963,6 +2053,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Master_DMA_Request_Enable HRTIM Master DMA Request Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_MASTER_DMA_NONE 0x00000000U /*!< No DMA request enable */
@@ -1978,6 +2069,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< */
/** @defgroup HRTIM_Timing_Unit_DMA_Request_Enable HRTIM Timing Unit DMA Request Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_TIM_DMA_NONE 0x00000000U /*!< No DMA request enable */
@@ -2748,6 +2840,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!< /* Exported macros -----------------------------------------------------------*/
/** @defgroup HRTIM_Exported_Macros HRTIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hsem.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hsem.h index 1ef97f3d47..1988f44014 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hsem.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hsem.h @@ -38,6 +38,7 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup HSEM_Exported_Macros HSEM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -118,6 +119,7 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup HSEM_Exported_Functions HSEM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -176,6 +178,7 @@ void HAL_HSEM_IRQHandler(void); /* Private macros ------------------------------------------------------------*/
/** @defgroup HSEM_Private_Macros HSEM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c.h index ea2cd88558..62076ac5f9 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c.h @@ -38,10 +38,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup I2C_Exported_Types I2C Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C Configuration Structure definition
* @{
*/
@@ -79,6 +81,7 @@ typedef struct */
/** @defgroup HAL_state_structure_definition HAL state structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL State structure definition
* @note HAL I2C State value coding follow below described bitmap :\n
* b7-b6 Error information\n
@@ -128,6 +131,7 @@ typedef enum */
/** @defgroup HAL_mode_structure_definition HAL mode structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL Mode structure definition
* @note HAL I2C Mode value coding follow below described bitmap :\n
* b7 (not used)\n
@@ -159,6 +163,7 @@ typedef enum */
/** @defgroup I2C_Error_Code_definition I2C Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C Error Code definition
* @{
*/
@@ -180,6 +185,7 @@ typedef enum */
/** @defgroup I2C_handle_Structure_definition I2C handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C handle Structure definition
* @{
*/
@@ -273,10 +279,12 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans /* Exported constants --------------------------------------------------------*/
/** @defgroup I2C_Exported_Constants I2C Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_XFEROPTIONS I2C Sequential Transfer Options
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_FIRST_FRAME ((uint32_t)I2C_SOFTEND_MODE)
@@ -296,6 +304,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_ADDRESSING_MODE I2C Addressing Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_ADDRESSINGMODE_7BIT (0x00000001U)
@@ -305,6 +314,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_DUAL_ADDRESSING_MODE I2C Dual Addressing Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_DUALADDRESS_DISABLE (0x00000000U)
@@ -314,6 +324,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_OWN_ADDRESS2_MASKS I2C Own Address2 Masks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_OA2_NOMASK ((uint8_t)0x00U)
@@ -329,6 +340,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_GENERAL_CALL_ADDRESSING_MODE I2C General Call Addressing Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_GENERALCALL_DISABLE (0x00000000U)
@@ -338,6 +350,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_NOSTRETCH_MODE I2C No-Stretch Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_NOSTRETCH_DISABLE (0x00000000U)
@@ -347,6 +360,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_MEMORY_ADDRESS_SIZE I2C Memory Address Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_MEMADD_SIZE_8BIT (0x00000001U)
@@ -356,6 +370,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_XFERDIRECTION I2C Transfer Direction Master Point of View
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_DIRECTION_TRANSMIT (0x00000000U)
@@ -365,6 +380,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_RELOAD_END_MODE I2C Reload End Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_RELOAD_MODE I2C_CR2_RELOAD
@@ -375,6 +391,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_START_STOP_MODE I2C Start or Stop Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_NO_STARTSTOP (0x00000000U)
@@ -386,6 +403,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I2C Interrupt definition
* Elements values convention: 0xXXXXXXXX
* - XXXXXXXX : Interrupt control mask
@@ -403,6 +421,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans */
/** @defgroup I2C_Flag_definition I2C Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_FLAG_TXE I2C_ISR_TXE
@@ -432,6 +451,7 @@ typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t Trans /* Exported macros -----------------------------------------------------------*/
/** @defgroup I2C_Exported_Macros I2C Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -676,6 +696,7 @@ uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c); /* Private constants ---------------------------------------------------------*/
/** @defgroup I2C_Private_Constants I2C Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -685,6 +706,7 @@ uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c); /* Private macros ------------------------------------------------------------*/
/** @defgroup I2C_Private_Macro I2C Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -757,6 +779,7 @@ uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c); /* Private Functions ---------------------------------------------------------*/
/** @defgroup I2C_Private_Functions I2C Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions are defined in stm32h7xx_hal_i2c.c file */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c_ex.h index bf89420b99..2559c6a394 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2c_ex.h @@ -40,10 +40,12 @@ extern "C" { /* Exported constants --------------------------------------------------------*/
/** @defgroup I2CEx_Exported_Constants I2C Extended Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2CEx_Analog_Filter I2C Extended Analog Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_ANALOGFILTER_ENABLE 0x00000000U
@@ -53,6 +55,7 @@ extern "C" { */
/** @defgroup I2CEx_FastModePlus I2C Extended Fast Mode Plus
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2C_FASTMODEPLUS_PB6 SYSCFG_PMCR_I2C_PB6_FMP /*!< Enable Fast Mode Plus on PB6 */
@@ -93,6 +96,7 @@ void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus); /* Private constants ---------------------------------------------------------*/
/** @defgroup I2CEx_Private_Constants I2C Extended Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -102,6 +106,7 @@ void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus); /* Private macros ------------------------------------------------------------*/
/** @defgroup I2CEx_Private_Macro I2C Extended Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_I2C_ANALOG_FILTER(FILTER) (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
@@ -149,6 +154,7 @@ void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus); /* Private Functions ---------------------------------------------------------*/
/** @defgroup I2CEx_Private_Functions I2C Extended Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions are defined in stm32h7xx_hal_i2c_ex.c file */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h index de19b9f6c5..a618418706 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup I2S_Exported_Types I2S Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -174,9 +175,11 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup I2S_Exported_Constants I2S Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2S_Error I2S Error
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_I2S_ERROR_NONE (0x00000000UL) /*!< No error */
@@ -196,6 +199,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Mode I2S Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_MODE_SLAVE_TX (0x00000000UL)
@@ -209,6 +213,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Standard I2S Standard
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_STANDARD_PHILIPS (0x00000000UL)
@@ -221,6 +226,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Data_Format I2S Data Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_DATAFORMAT_16B (0x00000000UL)
@@ -232,6 +238,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_MCLK_Output I2S MCLK Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_MCLKOUTPUT_ENABLE (SPI_I2SCFGR_MCKOE)
@@ -241,6 +248,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Audio_Frequency I2S Audio Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_AUDIOFREQ_192K (192000UL)
@@ -258,6 +266,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_FullDuplex_Mode I2S FullDuplex Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_CPOL_LOW (0x00000000UL)
@@ -267,6 +276,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_MSB_LSB_Transmission I2S MSB LSB Transmission
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_FIRSTBIT_MSB (0x00000000UL)
@@ -276,6 +286,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_WSInversion I2S Word Select Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_WS_INVERSION_DISABLE (0x00000000UL)
@@ -285,6 +296,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Data_24Bit_Alignment Data Padding 24Bit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_DATA_24BIT_ALIGNMENT_RIGHT (0x00000000UL)
@@ -294,6 +306,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Master_Keep_IO_State Keep IO State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_MASTER_KEEP_IO_STATE_DISABLE (0x00000000U)
@@ -303,6 +316,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_IT_RXP SPI_IER_RXPIE
@@ -316,6 +330,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to */
/** @defgroup I2S_Flags_Definition I2S Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define I2S_FLAG_RXP SPI_SR_RXP /* I2S status flag : Rx-Packet available flag */
@@ -335,6 +350,7 @@ typedef void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to /* Exported macros -----------------------------------------------------------*/
/** @defgroup I2S_Exported_macros I2S Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -517,6 +533,7 @@ uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup I2S_Private_Constants I2S Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -526,6 +543,7 @@ uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s); /* Private macros ------------------------------------------------------------*/
/** @defgroup I2S_Private_Macros I2S Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_irda.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_irda.h index ea0750f492..e2721302e9 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_irda.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_irda.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup IRDA_Exported_Types IRDA Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -232,10 +233,12 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup IRDA_Exported_Constants IRDA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IRDA_State_Definition IRDA State Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_IRDA_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
@@ -260,6 +263,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Error_Definition IRDA Error Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -277,6 +281,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Parity IRDA Parity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_PARITY_NONE 0x00000000U /*!< No parity */
@@ -287,6 +292,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_MODE_RX USART_CR1_RE /*!< RX mode */
@@ -297,6 +303,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Low_Power IRDA Low Power
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_POWERMODE_NORMAL 0x00000000U /*!< IRDA normal power mode */
@@ -306,6 +313,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_ClockPrescaler IRDA Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
@@ -325,6 +333,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_State IRDA State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_STATE_DISABLE 0x00000000U /*!< IRDA disabled */
@@ -334,6 +343,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Mode IRDA Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_MODE_DISABLE 0x00000000U /*!< Associated UART disabled in IRDA mode */
@@ -343,6 +353,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_One_Bit IRDA One Bit Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disabled */
@@ -352,6 +363,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_DMA_Tx IRDA DMA Tx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_DMA_TX_DISABLE 0x00000000U /*!< IRDA DMA TX disabled */
@@ -361,6 +373,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_DMA_Rx IRDA DMA Rx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_DMA_RX_DISABLE 0x00000000U /*!< IRDA DMA RX disabled */
@@ -370,6 +383,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Request_Parameters IRDA Request Parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
@@ -380,6 +394,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Flags IRDA Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the ISR register
* @{
@@ -401,6 +416,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0000ZZZZ0XXYYYYYb
* - YYYYY : Interrupt source position in the XX register (5bits)
* - XX : Interrupt source register (2bits)
@@ -434,6 +450,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
@@ -447,6 +464,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer */
/** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_IT_MASK 0x001FU /*!< IRDA Interruptions flags mask */
@@ -464,6 +482,7 @@ typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer /* Exported macros -----------------------------------------------------------*/
/** @defgroup IRDA_Exported_Macros IRDA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_irda_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_irda_ex.h index 95b1e7eaa2..0bae1035a9 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_irda_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_irda_ex.h @@ -33,6 +33,7 @@ extern "C" { */
/** @defgroup IRDAEx IRDAEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IRDA Extended HAL module driver
* @{
*/
@@ -40,10 +41,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup IRDAEx_Extended_Exported_Constants IRDAEx Extended Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IRDAEx_Word_Length IRDAEx Word Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IRDA_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long frame */
@@ -62,6 +65,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup IRDAEx_Private_Macros IRDAEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_iwdg.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_iwdg.h index a5c7b9f913..62c30a5ee6 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_iwdg.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_iwdg.h @@ -33,11 +33,13 @@ extern "C" { */
/** @defgroup IWDG IWDG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup IWDG_Exported_Types IWDG Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -74,10 +76,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup IWDG_Exported_Constants IWDG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IWDG_Prescaler IWDG Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IWDG_PRESCALER_4 0x00000000u /*!< IWDG prescaler set to 4 */
@@ -93,6 +97,7 @@ typedef struct */
/** @defgroup IWDG_Window_option IWDG Window option
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IWDG_WINDOW_DISABLE IWDG_WINR_WIN
@@ -107,6 +112,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup IWDG_Exported_Macros IWDG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -131,10 +137,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup IWDG_Exported_Functions IWDG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization/Start functions ********************************************/
@@ -144,6 +152,7 @@ HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg); */
/** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* I/O operation functions ****************************************************/
@@ -158,6 +167,7 @@ HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg); /* Private constants ---------------------------------------------------------*/
/** @defgroup IWDG_Private_Constants IWDG Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -175,6 +185,7 @@ HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg); /* Private macros ------------------------------------------------------------*/
/** @defgroup IWDG_Private_Macros IWDG Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_jpeg.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_jpeg.h index 419c435d23..fc67a7cbb5 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_jpeg.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_jpeg.h @@ -40,10 +40,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup JPEG_Exported_Types JPEG Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup JPEG_Configuration_Structure_definition JPEG Configuration for encoding Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG encoding configuration Structure definition
* @{
*/
@@ -67,6 +69,7 @@ typedef struct */
/** @defgroup HAL_JPEG_state_structure_definition HAL JPEG state structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL JPEG State structure definition
* @{
*/
@@ -87,6 +90,7 @@ typedef enum /** @defgroup JPEG_handle_Structure_definition JPEG handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG handle Structure definition
* @{
*/
@@ -164,6 +168,7 @@ typedef struct #if (USE_HAL_JPEG_REGISTER_CALLBACKS == 1)
/** @defgroup HAL_JPEG_Callback_ID_enumeration_definition HAL JPEG Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL JPEG Callback ID enumeration definition
* @{
*/
@@ -182,6 +187,7 @@ typedef enum */
/** @defgroup HAL_JPEG_Callback_pointer_definition HAL JPEG Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL JPEG Callback pointer definition
* @{
*/
@@ -205,10 +211,12 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 /* Exported constants --------------------------------------------------------*/
/** @defgroup JPEG_Exported_Constants JPEG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup JPEG_Error_Code_definition JPEG Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Error Code definition
* @{
*/
@@ -226,6 +234,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 */
/** @defgroup JPEG_Quantization_Table_Size JPEG Quantization Table Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Quantization Table Size
* @{
*/
@@ -236,6 +245,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 /** @defgroup JPEG_ColorSpace JPEG ColorSpace
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Color Space
* @{
*/
@@ -250,6 +260,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 /** @defgroup JPEG_ChromaSubsampling JPEG Chrominance Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Chrominance Sampling
* @{
*/
@@ -262,6 +273,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 */
/** @defgroup JPEG_ImageQuality JPEG Image Quality
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Min and Max Image Quality
* @{
*/
@@ -273,6 +285,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 */
/** @defgroup JPEG_Interrupt_configuration_definition JPEG Interrupt configuration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Interrupt definition
* @{
*/
@@ -287,6 +300,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 */
/** @defgroup JPEG_Flag_definition JPEG Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG Flags definition
* @{
*/
@@ -304,6 +318,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 */
/** @defgroup JPEG_PROCESS_PAUSE_RESUME_definition JPEG Process Pause Resume definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief JPEG process pause, resume definition
* @{
*/
@@ -320,6 +335,7 @@ typedef void (*pJPEG_DataReadyCallbackTypeDef)(JPEG_HandleTypeDef *hjpeg, uint8 /* Exported macro ------------------------------------------------------------*/
/** @defgroup JPEG_Exported_Macros JPEG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -561,6 +577,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private types -------------------------------------------------------------*/
/** @defgroup JPEG_Private_Types JPEG Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -570,6 +587,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private defines -----------------------------------------------------------*/
/** @defgroup JPEG_Private_Defines JPEG Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -579,6 +597,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private variables ---------------------------------------------------------*/
/** @defgroup JPEG_Private_Variables JPEG Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -588,6 +607,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private constants ---------------------------------------------------------*/
/** @defgroup JPEG_Private_Constants JPEG Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -597,6 +617,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private macros ------------------------------------------------------------*/
/** @defgroup JPEG_Private_Macros JPEG Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -620,6 +641,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup JPEG_Private_Functions_Prototypes JPEG Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -629,6 +651,7 @@ uint32_t HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg); /* Private functions ---------------------------------------------------------*/
/** @defgroup JPEG_Private_Functions JPEG Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_lptim.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_lptim.h index e2c70be4a3..806dedade1 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_lptim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_lptim.h @@ -40,6 +40,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup LPTIM_Exported_Types LPTIM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -195,10 +196,12 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin /* Exported constants --------------------------------------------------------*/
/** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPTIM_Clock_Source LPTIM Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC 0x00000000U
@@ -208,6 +211,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_PRESCALER_DIV1 0x00000000U
@@ -223,6 +227,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -233,6 +238,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION 0x00000000U
@@ -244,6 +250,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_CLOCKPOLARITY_RISING 0x00000000U
@@ -254,6 +261,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_TRIGSOURCE_SOFTWARE 0x0000FFFFU
@@ -270,6 +278,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0
@@ -280,6 +289,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U
@@ -291,6 +301,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -301,6 +312,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Counter_Source LPTIM Counter Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -311,6 +323,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Input1_Source LPTIM Input1 Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -326,6 +339,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Input2_Source LPTIM Input2 Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -336,6 +350,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -351,6 +366,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin */
/** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LPTIM_IT_DOWN LPTIM_IER_DOWNIE
@@ -370,6 +386,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin /* Exported macros -----------------------------------------------------------*/
/** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -540,6 +557,7 @@ typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< poin /* Exported functions --------------------------------------------------------*/
/** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -667,6 +685,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); /* Private types -------------------------------------------------------------*/
/** @defgroup LPTIM_Private_Types LPTIM Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -676,6 +695,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); /* Private variables ---------------------------------------------------------*/
/** @defgroup LPTIM_Private_Variables LPTIM Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -685,6 +705,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); /* Private constants ---------------------------------------------------------*/
/** @defgroup LPTIM_Private_Constants LPTIM Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -694,6 +715,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); /* Private macros ------------------------------------------------------------*/
/** @defgroup LPTIM_Private_Macros LPTIM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -785,6 +807,7 @@ HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); /* Private functions ---------------------------------------------------------*/
/** @defgroup LPTIM_Private_Functions LPTIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_ltdc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_ltdc.h index 319068c27a..3fdd32f178 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_ltdc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_ltdc.h @@ -35,12 +35,14 @@ extern "C" { */
/** @defgroup LTDC LTDC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief LTDC HAL module driver
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup LTDC_Exported_Types LTDC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MAX_LAYER 2U
@@ -223,10 +225,12 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup LTDC_Exported_Constants LTDC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LTDC_Error_Code LTDC Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_LTDC_ERROR_NONE 0x00000000U /*!< LTDC No error */
@@ -241,6 +245,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Layer LTDC Layer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_LAYER_1 0x00000000U /*!< LTDC Layer 1 */
@@ -250,6 +255,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_HSPOLARITY_AL 0x00000000U /*!< Horizontal Synchronization is active low. */
@@ -259,6 +265,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_VSPOLARITY_AL 0x00000000U /*!< Vertical Synchronization is active low. */
@@ -268,6 +275,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_DEPOLARITY_AL 0x00000000U /*!< Data Enable, is active low. */
@@ -277,6 +285,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_PCPOLARITY_IPC 0x00000000U /*!< input pixel clock. */
@@ -286,6 +295,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_SYNC LTDC SYNC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16U) /*!< Horizontal synchronization width. */
@@ -295,6 +305,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_COLOR 0x000000FFU /*!< Color mask */
@@ -303,6 +314,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_BLENDING_FACTOR1_CA 0x00000400U /*!< Blending factor : Cte Alpha */
@@ -312,6 +324,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_BLENDING_FACTOR2_CA 0x00000005U /*!< Blending factor : Cte Alpha */
@@ -321,6 +334,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Pixelformat LTDC Pixel format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_PIXEL_FORMAT_ARGB8888 0x00000000U /*!< ARGB8888 LTDC pixel format */
@@ -336,6 +350,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Alpha LTDC Alpha
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_ALPHA LTDC_LxCACR_CONSTA /*!< LTDC Constant Alpha mask */
@@ -344,6 +359,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_LAYER_Config LTDC LAYER Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16U) /*!< LTDC Layer stop position */
@@ -356,6 +372,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Interrupts LTDC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_IT_LI LTDC_IER_LIE /*!< LTDC Line Interrupt */
@@ -367,6 +384,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Flags LTDC Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_FLAG_LI LTDC_ISR_LIF /*!< LTDC Line Interrupt Flag */
@@ -378,6 +396,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer */
/** @defgroup LTDC_Reload_Type LTDC Reload Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_RELOAD_IMMEDIATE LTDC_SRCR_IMR /*!< Immediate Reload */
@@ -392,6 +411,7 @@ typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer /* Exported macro ------------------------------------------------------------*/
/** @defgroup LTDC_Exported_Macros LTDC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -619,6 +639,7 @@ uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc); /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup LTDC_Private_Macros LTDC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84U + (0x80U*(__LAYER__)))))
@@ -662,6 +683,7 @@ uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc); /* Private functions ---------------------------------------------------------*/
/** @defgroup LTDC_Private_Functions LTDC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_mdios.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_mdios.h index cd68360faf..4d91ae7289 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_mdios.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_mdios.h @@ -41,10 +41,12 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup MDIOS_Exported_Types MDIOS Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDIOS_Exported_Types_Group1 MDIOS State structures definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -61,6 +63,7 @@ typedef enum */
/** @defgroup MDIOS_Exported_Types_Group2 MDIOS Init Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -77,6 +80,7 @@ typedef struct */
/** @defgroup MDIOS_Exported_Types_Group4 MDIOS handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -143,10 +147,12 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin /* Exported constants --------------------------------------------------------*/
/** @defgroup MDIOS_Exported_Constants MDIOS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDIOS_Preamble_Check MDIOS Preamble Check
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_PREAMBLE_CHECK_ENABLE ((uint32_t)0x00000000U)
@@ -156,6 +162,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Input_Output_Registers_Definitions MDIOS Input Output Registers Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_REG0 ((uint32_t)0x00000000U)
@@ -195,6 +202,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Registers_Flags MDIOS Registers Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_REG0_FLAG ((uint32_t)0x00000001U)
@@ -235,6 +243,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Interrupt_sources Interrupt Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_IT_WRITE MDIOS_CR_WRIE
@@ -245,6 +254,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Interrupt_Flags MDIOS Interrupt Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_TURNAROUND_ERROR_FLAG MDIOS_SR_TERF
@@ -255,6 +265,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Error_Code MDIOS Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_MDIOS_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -270,6 +281,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/** @defgroup MDIOS_Wakeup_Line MDIOS Wakeup Line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MDIOS_WAKEUP_EXTI_LINE ((uint32_t)0x00000400) /* !< 42 - 32 = 10 */
@@ -282,6 +294,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin */
/* Exported macros -----------------------------------------------------------*/
/** @defgroup MDIOS_Exported_Macros MDIOS Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -484,6 +497,7 @@ typedef void (*pMDIOS_CallbackTypeDef)(MDIOS_HandleTypeDef * hmdios); /*!< poin /* Exported functions --------------------------------------------------------*/
/** @defgroup MDIOS_Exported_Functions MDIOS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -540,6 +554,7 @@ HAL_MDIOS_StateTypeDef HAL_MDIOS_GetState(MDIOS_HandleTypeDef *hmdios); /* Private types -------------------------------------------------------------*/
/** @defgroup MDIOS_Private_Types MDIOS Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -549,6 +564,7 @@ HAL_MDIOS_StateTypeDef HAL_MDIOS_GetState(MDIOS_HandleTypeDef *hmdios); /* Private variables ---------------------------------------------------------*/
/** @defgroup MDIOS_Private_Variables MDIOS Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -558,6 +574,7 @@ HAL_MDIOS_StateTypeDef HAL_MDIOS_GetState(MDIOS_HandleTypeDef *hmdios); /* Private constants ---------------------------------------------------------*/
/** @defgroup MDIOS_Private_Constants MDIOS Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -567,6 +584,7 @@ HAL_MDIOS_StateTypeDef HAL_MDIOS_GetState(MDIOS_HandleTypeDef *hmdios); /* Private macros ------------------------------------------------------------*/
/** @defgroup MDIOS_Private_Macros MDIOS Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -583,6 +601,7 @@ HAL_MDIOS_StateTypeDef HAL_MDIOS_GetState(MDIOS_HandleTypeDef *hmdios); /* Private functions ---------------------------------------------------------*/
/** @defgroup MDIOS_Private_Functions MDIOS Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_mdma.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_mdma.h index 6c1d9b714f..4ea3b0fd8e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_mdma.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_mdma.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup MDMA_Exported_Types MDMA Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Exported Types
* @{
*/
@@ -248,11 +249,13 @@ typedef struct __MDMA_HandleTypeDef /* Exported constants --------------------------------------------------------*/
/** @defgroup MDMA_Exported_Constants MDMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Exported constants
* @{
*/
/** @defgroup MDMA_Error_Codes MDMA Error Codes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Error Codes
* @{
*/
@@ -272,6 +275,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Request_selection MDMA Request selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA_Request_selection
* @{
*/
@@ -336,6 +340,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Transfer_TriggerMode MDMA Transfer Trigger Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Transfer Trigger Mode
* @{
*/
@@ -349,6 +354,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Priority_level MDMA Priority level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Priority level
* @{
*/
@@ -363,6 +369,7 @@ typedef struct __MDMA_HandleTypeDef /** @defgroup MDMA_Endianness MDMA Endianness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Endianness
* @{
*/
@@ -376,6 +383,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Source_increment_mode MDMA Source increment mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Source increment mode
* @{
*/
@@ -394,6 +402,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Destination_increment_mode MDMA Destination increment mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Destination increment mode
* @{
*/
@@ -412,6 +421,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Source_data_size MDMA Source data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Source data size
* @{
*/
@@ -425,6 +435,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Destination_data_size MDMA Destination data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Destination data size
* @{
*/
@@ -438,6 +449,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_data_Alignment MDMA data alignment
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA data alignment
* @{
*/
@@ -453,6 +465,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Source_burst MDMA Source burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Source burst
* @{
*/
@@ -470,6 +483,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_Destination_burst MDMA Destination burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA Destination burst
* @{
*/
@@ -487,6 +501,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_interrupt_enable_definitions MDMA interrupt enable definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA interrupt enable definitions
* @{
*/
@@ -501,6 +516,7 @@ typedef struct __MDMA_HandleTypeDef */
/** @defgroup MDMA_flag_definitions MDMA flag definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief MDMA flag definitions
* @{
*/
@@ -522,6 +538,7 @@ typedef struct __MDMA_HandleTypeDef /* Exported macro ------------------------------------------------------------*/
/** @defgroup MDMA_Exported_Macros MDMA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -615,11 +632,13 @@ typedef struct __MDMA_HandleTypeDef /* Exported functions --------------------------------------------------------*/
/** @defgroup MDMA_Exported_Functions MDMA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization and de-initialization functions *****************************/
/** @defgroup MDMA_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions
* @{
*/
@@ -636,6 +655,7 @@ HAL_StatusTypeDef HAL_MDMA_UnRegisterCallback(MDMA_HandleTypeDef *hmdma, HAL_MDM /* Linked list operation functions ********************************************/
/** @defgroup MDMA_Exported_Functions_Group2 Linked List operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Linked list operation functions
* @{
*/
@@ -653,6 +673,7 @@ HAL_StatusTypeDef HAL_MDMA_LinkedList_DisableCircularMode(MDMA_HandleTypeDef *hm /* IO operation functions *****************************************************/
/** @defgroup MDMA_Exported_Functions_Group3 I/O operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief I/O operation functions
* @{
*/
@@ -670,6 +691,7 @@ void HAL_MDMA_IRQHandler(MDMA_HandleTypeDef *hmdma); /* Peripheral State and Error functions ***************************************/
/** @defgroup MDMA_Exported_Functions_Group4 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
* @{
*/
@@ -686,6 +708,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private types -------------------------------------------------------------*/
/** @defgroup MDMA_Private_Types MDMA Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -695,6 +718,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private defines -----------------------------------------------------------*/
/** @defgroup MDMA_Private_Defines MDMA Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -704,6 +728,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private variables ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Variables MDMA Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -713,6 +738,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private constants ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Constants MDMA Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -722,6 +748,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private macros ------------------------------------------------------------*/
/** @defgroup MDMA_Private_Macros MDMA Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -822,6 +849,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup MDMA_Private_Functions_Prototypes MDMA Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -831,6 +859,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma); /* Private functions ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Functions MDMA Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h index c8679bba32..6565a05f3c 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h @@ -38,10 +38,12 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup MMC_Exported_Types MMC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -60,6 +62,7 @@ typedef enum */
/** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef uint32_t HAL_MMC_CardStateTypeDef;
@@ -78,6 +81,7 @@ typedef uint32_t HAL_MMC_CardStateTypeDef; */
/** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MMC_InitTypeDef SDMMC_InitTypeDef
@@ -162,6 +166,7 @@ typedef struct */
/** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -210,6 +215,7 @@ typedef struct */
/** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -232,6 +238,7 @@ typedef struct #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
/** @defgroup MMC_Exported_Types_Group6 MMC Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -253,6 +260,7 @@ typedef enum */
/** @defgroup MMC_Exported_Types_Group7 MMC Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc);
@@ -266,12 +274,14 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); /* Exported constants --------------------------------------------------------*/
/** @defgroup MMC_Exported_Constants Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MMC_BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
/** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
@@ -319,6 +329,7 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); */
/** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MMC_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
@@ -334,6 +345,7 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); */
/** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -349,6 +361,7 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); */
/** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define MMC_LOW_CAPACITY_CARD ((uint32_t)0x00000000U) /*!< MMC Card Capacity <=2Gbytes */
@@ -364,6 +377,7 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); /* Exported macro ------------------------------------------------------------*/
/** @defgroup MMC_Exported_macros MMC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -585,10 +599,12 @@ typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc); /* Exported functions --------------------------------------------------------*/
/** @defgroup MMC_Exported_Functions MMC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
@@ -602,6 +618,7 @@ void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc); */
/** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Blocking mode: Polling */
@@ -633,6 +650,7 @@ HAL_StatusTypeDef HAL_MMC_UnRegisterCallback(MMC_HandleTypeDef *hmmc, HAL_MMC_Ca */
/** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
@@ -642,6 +660,7 @@ HAL_StatusTypeDef HAL_MMC_ConfigSpeedBusOperation(MMC_HandleTypeDef *hmmc, uint3 */
/** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
@@ -653,6 +672,7 @@ HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoT */
/** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
@@ -662,6 +682,7 @@ uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc); */
/** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
@@ -672,6 +693,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private types -------------------------------------------------------------*/
/** @defgroup MMC_Private_Types MMC Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -681,6 +703,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private defines -----------------------------------------------------------*/
/** @defgroup MMC_Private_Defines MMC Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -690,6 +713,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private variables ---------------------------------------------------------*/
/** @defgroup MMC_Private_Variables MMC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -699,6 +723,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private constants ---------------------------------------------------------*/
/** @defgroup MMC_Private_Constants MMC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -708,6 +733,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private macros ------------------------------------------------------------*/
/** @defgroup MMC_Private_Macros MMC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -717,6 +743,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -726,6 +753,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc); /* Private functions ---------------------------------------------------------*/
/** @defgroup MMC_Private_Functions MMC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc_ex.h index 38f8838a29..414bf7aac8 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc_ex.h @@ -39,10 +39,12 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup MMCEx_Exported_Types MMCEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MMCEx_Exported_Types_Group1 MMC Internal DMA Buffer structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -64,10 +66,12 @@ typedef enum /* Exported macro ------------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup MMCEx_Exported_Functions MMCEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MMCEx_Exported_Functions_Group1 MultiBuffer functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_MMCEx_ConfigDMAMultiBuffer(MMC_HandleTypeDef *hmmc, uint32_t * pDataBuffer0, uint32_t * pDataBuffer1, uint32_t BufferSize);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_nand.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_nand.h index 1f5fd6ee48..a8e107319f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_nand.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_nand.h @@ -40,6 +40,7 @@ extern "C" { /* Exported typedef ----------------------------------------------------------*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup NAND_Exported_Types NAND Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -160,6 +161,7 @@ typedef void (*pNAND_CallbackTypeDef)(NAND_HandleTypeDef *hnand); /* Exported constants --------------------------------------------------------*/
/* Exported macro ------------------------------------------------------------*/
/** @defgroup NAND_Exported_Macros NAND Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -269,6 +271,7 @@ uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup NAND_Private_Constants NAND Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define NAND_DEVICE 0x80000000UL
@@ -304,6 +307,7 @@ uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand); /* Private macros ------------------------------------------------------------*/
/** @defgroup NAND_Private_Macros NAND Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_nor.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_nor.h index 51c65884c1..10794d8108 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_nor.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_nor.h @@ -39,6 +39,7 @@ extern "C" { /* Exported typedef ----------------------------------------------------------*/
/** @defgroup NOR_Exported_Types NOR Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -148,6 +149,7 @@ typedef void (*pNOR_CallbackTypeDef)(NOR_HandleTypeDef *hnor); /* Exported constants --------------------------------------------------------*/
/* Exported macro ------------------------------------------------------------*/
/** @defgroup NOR_Exported_Macros NOR Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Reset NOR handle state
@@ -242,6 +244,7 @@ HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Addres /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup NOR_Private_Constants NOR Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* NOR device IDs addresses */
@@ -274,6 +277,7 @@ HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Addres /* Private macros ------------------------------------------------------------*/
/** @defgroup NOR_Private_Macros NOR Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_opamp.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_opamp.h index 31660157da..b626d17b56 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_opamp.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_opamp.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup OPAMP_Exported_Types OPAMP Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -170,10 +171,12 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); /* Exported constants --------------------------------------------------------*/
/** @defgroup OPAMP_Exported_Constants OPAMP Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMP_Mode OPAMP Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OPAMP_STANDALONE_MODE 0x00000000U /*!< standalone mode */
@@ -185,6 +188,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_NonInvertingInput OPAMP Non Inverting Input
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -199,6 +203,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_InvertingInput OPAMP Inverting Input
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -210,6 +215,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_PgaConnect OPAMP Pga Connect
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -224,6 +230,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_PgaGain OPAMP Pga Gain
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -237,6 +244,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_PowerMode OPAMP PowerMode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OPAMP_POWERMODE_NORMAL 0x00000000U
@@ -248,6 +256,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); /** @defgroup OPAMP_VREF OPAMP VREF
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -261,6 +270,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_UserTrimming OPAMP User Trimming
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OPAMP_TRIMMING_FACTORY 0x00000000U /*!< Factory trimming */
@@ -272,6 +282,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); */
/** @defgroup OPAMP_FactoryTrimming OPAMP Factory Trimming
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OPAMP_FACTORYTRIMMING_DUMMY 0xFFFFFFFFU /*!< Dummy value if trimming value could not be retrieved */
@@ -289,6 +300,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); /* Private constants ---------------------------------------------------------*/
/** @defgroup OPAMP_Private_Constants OPAMP Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief OPAMP Private constants and defines
* @{
*/
@@ -308,6 +320,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); /* Exported macros -----------------------------------------------------------*/
/** @defgroup OPAMP_Exported_Macros OPAMP Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -324,6 +337,7 @@ typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); /* Private macro -------------------------------------------------------------*/
/** @defgroup OPAMP_Private_Macros OPAMP Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h index 99ddf222c9..5ec3556c52 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup OSPI_Exported_Types OSPI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -296,10 +297,12 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); /* Exported constants --------------------------------------------------------*/
/** @defgroup OSPI_Exported_Constants OSPI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OSPI_State OSPI State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_STATE_RESET ((uint32_t)0x00000000U) /*!< Initial state */
@@ -320,6 +323,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_ErrorCode OSPI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -336,6 +340,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DualQuad OSPI Dual-Quad
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DUALQUAD_DISABLE ((uint32_t)0x00000000U) /*!< Dual-Quad mode disabled */
@@ -345,6 +350,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_MemoryType OSPI Memory Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_MEMTYPE_MICRON ((uint32_t)0x00000000U) /*!< Micron mode */
@@ -357,6 +363,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_FreeRunningClock OSPI Free Running Clock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_FREERUNCLK_DISABLE ((uint32_t)0x00000000U) /*!< CLK is not free running */
@@ -366,6 +373,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_ClockMode OSPI Clock Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_CLOCK_MODE_0 ((uint32_t)0x00000000U) /*!< CLK must stay low while nCS is high */
@@ -375,6 +383,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_WrapSize OSPI Wrap-Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_WRAP_NOT_SUPPORTED ((uint32_t)0x00000000U) /*!< wrapped reads are not supported by the memory */
@@ -387,6 +396,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_SampleShifting OSPI Sample Shifting
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_SAMPLE_SHIFTING_NONE ((uint32_t)0x00000000U) /*!< No shift */
@@ -396,6 +406,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DelayHoldQuarterCycle OSPI Delay Hold Quarter Cycle
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DHQC_DISABLE ((uint32_t)0x00000000U) /*!< No Delay */
@@ -405,6 +416,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DelayBlockBypass OSPI Delay Block Bypaas
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DELAY_BLOCK_USED ((uint32_t)0x00000000U) /*!< Sampling clock is delayed by the delay block */
@@ -414,6 +426,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_OperationType OSPI Operation Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_OPTYPE_COMMON_CFG ((uint32_t)0x00000000U) /*!< Common configuration (indirect or auto-polling mode) */
@@ -425,6 +438,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_FlashID OSPI Flash Id
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_FLASH_ID_1 ((uint32_t)0x00000000U) /*!< FLASH 1 selected */
@@ -434,6 +448,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_InstructionMode OSPI Instruction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_INSTRUCTION_NONE ((uint32_t)0x00000000U) /*!< No instruction */
@@ -446,6 +461,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_InstructionSize OSPI Instruction Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_INSTRUCTION_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit instruction */
@@ -457,6 +473,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_InstructionDtrMode OSPI Instruction DTR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_INSTRUCTION_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for instruction phase */
@@ -466,6 +483,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AddressMode OSPI Address Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ADDRESS_NONE ((uint32_t)0x00000000U) /*!< No address */
@@ -478,6 +496,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AddressSize OSPI Address Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ADDRESS_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit address */
@@ -489,6 +508,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AddressDtrMode OSPI Address DTR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ADDRESS_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for address phase */
@@ -498,6 +518,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AlternateBytesMode OSPI Alternate Bytes Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ALTERNATE_BYTES_NONE ((uint32_t)0x00000000U) /*!< No alternate bytes */
@@ -510,6 +531,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AlternateBytesSize OSPI Alternate Bytes Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ALTERNATE_BYTES_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit alternate bytes */
@@ -521,6 +543,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AlternateBytesDtrMode OSPI Alternate Bytes DTR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_ALTERNATE_BYTES_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for alternate bytes phase */
@@ -530,6 +553,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DataMode OSPI Data Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DATA_NONE ((uint32_t)0x00000000U) /*!< No data */
@@ -542,6 +566,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DataDtrMode OSPI Data DTR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DATA_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for data phase */
@@ -551,6 +576,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_DQSMode OSPI DQS Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_DQS_DISABLE ((uint32_t)0x00000000U) /*!< DQS disabled */
@@ -560,6 +586,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_SIOOMode OSPI SIOO Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_SIOO_INST_EVERY_CMD ((uint32_t)0x00000000U) /*!< Send instruction on every transaction */
@@ -569,6 +596,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_WriteZeroLatency OSPI Hyperbus Write Zero Latency Activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_LATENCY_ON_WRITE ((uint32_t)0x00000000U) /*!< Latency on write accesses */
@@ -578,6 +606,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_LatencyMode OSPI Hyperbus Latency Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_VARIABLE_LATENCY ((uint32_t)0x00000000U) /*!< Variable initial latency */
@@ -587,6 +616,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AddressSpace OSPI Hyperbus Address Space
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_MEMORY_ADDRESS_SPACE ((uint32_t)0x00000000U) /*!< HyperBus memory mode */
@@ -596,6 +626,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_MatchMode OSPI Match Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_MATCH_MODE_AND ((uint32_t)0x00000000U) /*!< AND match mode between unmasked bits */
@@ -605,6 +636,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_AutomaticStop OSPI Automatic Stop
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_AUTOMATIC_STOP_DISABLE ((uint32_t)0x00000000U) /*!< AutoPolling stops only with abort or OSPI disabling */
@@ -614,6 +646,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_TimeOutActivation OSPI Timeout Activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_TIMEOUT_COUNTER_DISABLE ((uint32_t)0x00000000U) /*!< Timeout counter disabled, nCS remains active */
@@ -623,6 +656,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_Flags OSPI Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_FLAG_BUSY OCTOSPI_SR_BUSY /*!< Busy flag: operation is ongoing */
@@ -636,6 +670,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_Interrupts OSPI Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_IT_TO OCTOSPI_CR_TOIE /*!< Interrupt on the timeout flag */
@@ -648,6 +683,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPI_Timeout_definition OSPI Timeout definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPI_TIMEOUT_DEFAULT_VALUE ((uint32_t)5000U) /* 5 s */
@@ -656,6 +692,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */
/** @defgroup OSPIM_IOPort OSPI IO Manager IO Port
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OSPIM_IOPORT_1_LOW ((uint32_t)(OCTOSPIM_PCR_IOLEN | 0x1U)) /*!< Port 1 - IO[3:0] */
@@ -683,6 +720,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); /* Exported macros -----------------------------------------------------------*/
/** @defgroup OSPI_Exported_Macros OSPI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Reset OSPI handle state.
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_otfdec.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_otfdec.h index 70a9c15d40..16d05c5563 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_otfdec.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_otfdec.h @@ -40,10 +40,12 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup OTFDEC_Exported_Types OTFDEC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OTFDEC_Exported_Types_Group1 OTFDEC region configuration definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -67,6 +69,7 @@ typedef struct */
/** @defgroup OTFDEC_Exported_Types_Group2 OTFDEC Peripheral handle definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -135,10 +138,12 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po /* Exported constants --------------------------------------------------------*/
/** @defgroup OTFDEC_Exported_Constants OTFDEC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OTFDEC_Interrupts OTFDEC Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OTFDEC_SEC_ERROR_INT (OTFDEC_IER_SEIE ) /*!< OTFDEC security error interrupt */
@@ -153,6 +158,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po */
/** @defgroup OTFDEC_Region_Enable OTFDEC Region Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OTFDEC_REG_CONFIGR_REG_DISABLE 0x00000000U /*!< OTFDEC region encryption or on-the-fly decryption disable */
@@ -162,6 +168,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po */
/** @defgroup OTFDEC_Region_Configuration_Lock OTFDEC Region Configuration Lock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OTFDEC_REG_CONFIGR_LOCK_DISABLE 0x00000000U /*!< OTFDEC region configuration lock disable */
@@ -171,6 +178,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po */
/** @defgroup OTFDEC_Region_Operating_Mode OTFDEC Region Operating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OTFDEC_REG_MODE_INSTRUCTION_ACCESSES_ONLY 0x00000000U /*!< Only instruction accesses are decrypted */
@@ -182,6 +190,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po */
/** @defgroup OTFDEC_Error_Definition OTFDEC Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_OTFDEC_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -196,6 +205,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po */
/** @defgroup OTFDEC_Regions_Index OTFDEC Regions Index
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define OTFDEC_REGION1 ((uint32_t)0x00000000U) /*!< OTFDEC region 1 */
@@ -212,6 +222,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po /* Exported macro ------------------------------------------------------------*/
/** @defgroup OTFDEC_Exported_Macros OTFDEC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -272,6 +283,7 @@ typedef void (*pOTFDEC_CallbackTypeDef)(OTFDEC_HandleTypeDef *hotfdec); /*!< po /* Exported functions --------------------------------------------------------*/
/** @defgroup OTFDEC_Exported_Functions OTFDEC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -333,6 +345,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionGetConfig(OTFDEC_HandleTypeDef *hotfdec, uint /* Private types -------------------------------------------------------------*/
/** @defgroup OTFDEC_Private_Types OTFDEC Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -342,6 +355,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionGetConfig(OTFDEC_HandleTypeDef *hotfdec, uint /* Private variables ---------------------------------------------------------*/
/** @defgroup OTFDEC_Private_Variables OTFDEC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -351,6 +365,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionGetConfig(OTFDEC_HandleTypeDef *hotfdec, uint /* Private constants ---------------------------------------------------------*/
/** @defgroup OTFDEC_Private_Constants OTFDEC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -359,6 +374,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionGetConfig(OTFDEC_HandleTypeDef *hotfdec, uint /* Private macros ------------------------------------------------------------*/
/** @defgroup OTFDEC_Private_Macros OTFDEC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -417,6 +433,7 @@ HAL_StatusTypeDef HAL_OTFDEC_RegionGetConfig(OTFDEC_HandleTypeDef *hotfdec, uint /* Private functions ---------------------------------------------------------*/
/** @defgroup OTFDEC_Private_Functions OTFDEC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_pcd.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_pcd.h index a47aaaef8f..731f117d37 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_pcd.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_pcd.h @@ -40,6 +40,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup PCD_Exported_Types PCD Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -146,10 +147,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup PCD_Exported_Constants PCD Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PCD_Speed PCD Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PCD_SPEED_HIGH USBD_HS_SPEED
@@ -160,6 +163,7 @@ typedef struct */
/** @defgroup PCD_PHY_Module PCD PHY Module
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PCD_PHY_ULPI 1U
@@ -170,6 +174,7 @@ typedef struct */
/** @defgroup PCD_Error_Code_definition PCD Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief PCD Error Code definition
* @{
*/
@@ -187,6 +192,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup PCD_Exported_Macros PCD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -233,6 +239,7 @@ void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd); #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
/** @defgroup HAL_PCD_Callback_ID_enumeration_definition HAL USB OTG PCD Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL USB OTG PCD Callback ID enumeration definition
* @{
*/
@@ -255,6 +262,7 @@ typedef enum */
/** @defgroup HAL_PCD_Callback_pointer_definition HAL USB OTG PCD Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief HAL USB OTG PCD Callback pointer definition
* @{
*/
@@ -357,9 +365,11 @@ PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd); /* Private constants ---------------------------------------------------------*/
/** @defgroup PCD_Private_Constants PCD Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USB_EXTI_Line_Interrupt USB EXTI line interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
@@ -411,6 +421,7 @@ PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd); /* Private macros ------------------------------------------------------------*/
/** @defgroup PCD_Private_Macros PCD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_pssi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_pssi.h index b890f5832c..e541897716 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_pssi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_pssi.h @@ -39,6 +39,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup PSSI_Exported_Types PSSI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -127,10 +128,12 @@ typedef enum /* Exported constants --------------------------------------------------------*/
/** @defgroup PSSI_Exported_Constants PSSI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PSSI_Error_Code PSSI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_ERROR_NONE 0x00000000U /*!< No error */
@@ -147,6 +150,7 @@ typedef enum */
/** @defgroup PSSI_DATA_WIDTH PSSI Data Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -158,6 +162,7 @@ typedef enum */
/** @defgroup PSSI_BUS_WIDTH PSSI Bus Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -167,6 +172,7 @@ typedef enum * @}
*/
/** @defgroup PSSI_MODE PSSI mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_UNIDIRECTIONAL 0x00000000U /*!< Uni-directional mode */
@@ -176,6 +182,7 @@ typedef enum */
/** @defgroup PSSI_ControlSignal Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_DE_RDY_DISABLE (0x0U << PSSI_CR_DERDYCFG_Pos) /*!< Neither DE nor RDY are enabled */
@@ -193,6 +200,7 @@ typedef enum /** @defgroup PSSI_Data_Enable_Polarity Data Enable Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_DEPOL_ACTIVE_LOW 0x0U /*!< Active Low */
@@ -201,6 +209,7 @@ typedef enum * @}
*/
/** @defgroup PSSI_Reday_Polarity Reday Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_RDYPOL_ACTIVE_LOW 0x0U /*!< Active Low */
@@ -210,6 +219,7 @@ typedef enum */
/** @defgroup PSSI_Clock_Polarity Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_PSSI_FALLING_EDGE 0x0U /*!< Fallling Edge */
@@ -222,6 +232,7 @@ typedef enum /** @defgroup PSSI_DEFINITION PSSI definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -247,6 +258,7 @@ typedef enum */
/** @defgroup PSSI_Interrupts PSSI Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -264,6 +276,7 @@ typedef enum */
/* Exported macros ------------------------------------------------------------*/
/** @defgroup PSSI_Exported_Macros PSSI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr.h index 0d4624022c..0cb0a80130 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup PWR_Exported_Types PWR Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -64,10 +65,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup PWR_Exported_Constants PWR Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_PVD_detection_level PWR PVD detection level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_PVDLEVEL_0 PWR_CR1_PLS_LEV0 /*!< Programmable voltage detector
@@ -91,6 +94,7 @@ typedef struct */
/** @defgroup PWR_PVD_Mode PWR PVD Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_PVD_MODE_NORMAL (0x00000000U) /*!< Basic mode is used */
@@ -105,6 +109,7 @@ typedef struct */
/** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in SLEEP/STOP mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_MAINREGULATOR_ON (0U)
@@ -114,6 +119,7 @@ typedef struct */
/** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_SLEEPENTRY_WFI (0x01U)
@@ -123,6 +129,7 @@ typedef struct */
/** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_STOPENTRY_WFI (0x01U)
@@ -132,6 +139,7 @@ typedef struct */
/** @defgroup PWR_Regulator_Voltage_Scale PWR Regulator Voltage Scale
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(PWR_SRDCR_VOS)
@@ -150,6 +158,7 @@ typedef struct */
/** @defgroup PWR_Flag PWR Flag
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* PWR CPU flag */
@@ -199,6 +208,7 @@ typedef struct */
/** @defgroup PWR_ENABLE_WUP_Mask PWR Enable WUP Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_EWUP_MASK (0x0FFF3F3FU)
@@ -211,6 +221,7 @@ typedef struct */
/* Exported macro ------------------------------------------------------------*/
/** @defgroup PWR_Exported_Macro PWR Exported Macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -690,10 +701,12 @@ void HAL_PWR_DisableSEVOnPend(void); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup PWR_Private_Constants PWR Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_PVD_EXTI_Line PWR PVD EXTI Line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_EXTI_LINE_PVD EXTI_IMR1_IM16 /*!< External interrupt line 16
@@ -707,10 +720,12 @@ void HAL_PWR_DisableSEVOnPend(void); */
/* Private macros ------------------------------------------------------------*/
/** @defgroup PWR_Private_Macros PWR Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_IS_PWR_Definitions PWR Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Check PVD level parameter */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr_ex.h index ebad73c54c..457255ecec 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_pwr_ex.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup PWREx_Exported_Types PWREx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -95,9 +96,11 @@ typedef enum /* Exported constants --------------------------------------------------------*/
/** @defgroup PWREx_Exported_Constants PWREx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWREx_WakeUp_Pins PWREx Wake-Up Pins
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* High level and No pull (default configuration) */
@@ -128,6 +131,7 @@ typedef enum */
/** @defgroup PWREx_PIN_Polarity PWREx Pin Polarity configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_PIN_POLARITY_HIGH (0x00000000U)
@@ -137,6 +141,7 @@ typedef enum */
/** @defgroup PWREx_PIN_Pull PWREx Pin Pull configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_PIN_NO_PULL (0x00000000U)
@@ -147,6 +152,7 @@ typedef enum */
/** @defgroup PWREx_Wakeup_Pins_Flags PWREx Wakeup Pins Flags.
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_WAKEUP_FLAG1 PWR_WKUPFR_WKUPF1 /*!< Wakeup flag on PA0 */
@@ -164,6 +170,7 @@ typedef enum #if defined (DUAL_CORE)
/** @defgroup PWREx_Core_Select PWREx Core definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_CORE_CPU1 (0x00000000U)
@@ -174,6 +181,7 @@ typedef enum #endif /* defined (DUAL_CORE) */
/** @defgroup PWREx_Domains PWREx Domains definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_D1_DOMAIN (0x00000000U)
@@ -186,6 +194,7 @@ typedef enum */
/** @defgroup PWREx_Domain_Flags PWREx Domain Flags definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (DUAL_CORE)
@@ -200,6 +209,7 @@ typedef enum */
/** @defgroup PWREx_D3_State PWREx D3 Domain State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_D3_DOMAIN_STOP (0x00000000U)
@@ -210,6 +220,7 @@ typedef enum */
/** @defgroup PWREx_Supply_configuration PWREx Supply configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_LDO_SUPPLY PWR_CR3_LDOEN /*!< Core domains are suppplied from the LDO */
@@ -236,6 +247,7 @@ typedef enum /** @defgroup PWREx_AVD_detection_level PWREx AVD detection level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_AVDLEVEL_0 PWR_CR1_ALS_LEV0 /*!< Analog voltage detector level 0
@@ -251,6 +263,7 @@ typedef enum */
/** @defgroup PWREx_AVD_Mode PWREx AVD Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_AVD_MODE_NORMAL (0x00000000U) /*!< Basic mode is used */
@@ -265,6 +278,7 @@ typedef enum */
/** @defgroup PWREx_Regulator_Voltage_Scale PWREx Regulator Voltage Scale
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_REGULATOR_SVOS_SCALE5 (PWR_CR1_SVOS_0)
@@ -275,6 +289,7 @@ typedef enum */
/** @defgroup PWREx_VBAT_Battery_Charging_Resistor PWR battery charging resistor selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_BATTERY_CHARGING_RESISTOR_5 (0x00000000U) /*!< VBAT charging through a 5 kOhms resistor */
@@ -284,6 +299,7 @@ typedef enum */
/** @defgroup PWREx_VBAT_Thresholds PWREx VBAT Thresholds
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_VBAT_BETWEEN_HIGH_LOW_THRESHOLD (0x00000000U)
@@ -294,6 +310,7 @@ typedef enum */
/** @defgroup PWREx_TEMP_Thresholds PWREx Temperature Thresholds
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_TEMP_BETWEEN_HIGH_LOW_THRESHOLD (0x00000000U)
@@ -303,6 +320,7 @@ typedef enum * @}
*/
/** @defgroup PWREx_AVD_EXTI_Line PWREx AVD EXTI Line 16
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_EXTI_LINE_AVD EXTI_IMR1_IM16 /*!< External interrupt line 16
@@ -313,6 +331,7 @@ typedef enum #if defined (PWR_CR1_SRDRAMSO)
/** @defgroup PWREx_Memory_Shut_Off Memory shut-off block selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define PWR_SRD_AHB_MEMORY_BLOCK PWR_CR1_SRDRAMSO /*!< SmartRun domain AHB memory shut-off in DStop/DStop2 low-power mode */
@@ -337,6 +356,7 @@ typedef enum /* Exported macro ------------------------------------------------------------*/
/** @defgroup PWREx_Exported_Macro PWREx Exported Macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -593,10 +613,12 @@ void HAL_PWREx_AVDCallback(void); /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup PWREx_Private_Macros PWREx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWREx_IS_PWR_Definitions PWREx Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Check PWR regulator configuration parameter */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h index d7d955c1c5..b123799910 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup QSPI_Exported_Types QSPI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -221,10 +222,12 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); /* Exported constants --------------------------------------------------------*/
/** @defgroup QSPI_Exported_Constants QSPI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup QSPI_ErrorCode QSPI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_QSPI_ERROR_NONE 0x00000000U /*!< No error */
@@ -240,6 +243,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_SampleShifting QSPI Sample Shifting
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_SAMPLE_SHIFTING_NONE 0x00000000U /*!<No clock cycle shift to sample data*/
@@ -249,6 +253,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_ChipSelectHighTime QSPI ChipSelect High Time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_CS_HIGH_TIME_1_CYCLE 0x00000000U /*!<nCS stay high for at least 1 clock cycle between commands*/
@@ -264,6 +269,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_ClockMode QSPI Clock Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_CLOCK_MODE_0 0x00000000U /*!<Clk stays low while nCS is released*/
@@ -273,6 +279,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_Flash_Select QSPI Flash Select
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_FLASH_ID_1 0x00000000U /*!<FLASH 1 selected*/
@@ -282,6 +289,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_DualFlash_Mode QSPI Dual Flash Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_DUALFLASH_ENABLE ((uint32_t)QUADSPI_CR_DFM) /*!<Dual-flash mode enabled*/
@@ -291,6 +299,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_AddressSize QSPI Address Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_ADDRESS_8_BITS 0x00000000U /*!<8-bit address*/
@@ -302,6 +311,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_AlternateBytesSize QSPI Alternate Bytes Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_ALTERNATE_BYTES_8_BITS 0x00000000U /*!<8-bit alternate bytes*/
@@ -313,6 +323,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_InstructionMode QSPI Instruction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_INSTRUCTION_NONE 0x00000000U /*!<No instruction*/
@@ -324,6 +335,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_AddressMode QSPI Address Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_ADDRESS_NONE 0x00000000U /*!<No address*/
@@ -335,6 +347,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_AlternateBytesMode QSPI Alternate Bytes Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_ALTERNATE_BYTES_NONE 0x00000000U /*!<No alternate bytes*/
@@ -346,6 +359,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_DataMode QSPI Data Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_DATA_NONE 0x00000000U /*!<No data*/
@@ -357,6 +371,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_DdrMode QSPI DDR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_DDR_MODE_DISABLE 0x00000000U /*!<Double data rate mode disabled*/
@@ -366,6 +381,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_DdrHoldHalfCycle QSPI DDR Data Output Delay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_DDR_HHC_ANALOG_DELAY 0x00000000U /*!<Delay the data output using analog delay in DDR mode*/
@@ -375,6 +391,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_SIOOMode QSPI Send Instruction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_SIOO_INST_EVERY_CMD 0x00000000U /*!<Send instruction on every transaction*/
@@ -384,6 +401,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_MatchMode QSPI Match Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_MATCH_MODE_AND 0x00000000U /*!<AND match mode between unmasked bits*/
@@ -393,6 +411,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_AutomaticStop QSPI Automatic Stop
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_AUTOMATIC_STOP_DISABLE 0x00000000U /*!<AutoPolling stops only with abort or QSPI disabling*/
@@ -402,6 +421,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_TimeOutActivation QSPI Timeout Activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_TIMEOUT_COUNTER_DISABLE 0x00000000U /*!<Timeout counter disabled, nCS remains active*/
@@ -411,6 +431,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_Flags QSPI Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_FLAG_BUSY QUADSPI_SR_BUSY /*!<Busy flag: operation is ongoing*/
@@ -424,6 +445,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_Interrupts QSPI Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define QSPI_IT_TO QUADSPI_CR_TOIE /*!<Interrupt on the timeout flag*/
@@ -436,6 +458,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); */
/** @defgroup QSPI_Timeout_definition QSPI Timeout definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief QSPI Timeout definition
* @{
*/
@@ -450,6 +473,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi); /* Exported macros -----------------------------------------------------------*/
/** @defgroup QSPI_Exported_Macros QSPI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Reset QSPI handle state.
@@ -637,6 +661,7 @@ HAL_StatusTypeDef HAL_QSPI_SetFlashID (QSPI_HandleTypeDef *hqspi, uint3 /* Private macros ------------------------------------------------------------*/
/** @defgroup QSPI_Private_Macros QSPI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_QSPI_CLOCK_PRESCALER(PRESCALER) ((PRESCALER) <= 0xFFU)
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_ramecc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_ramecc.h index 0627d39807..b137f248e6 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_ramecc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_ramecc.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup RAMECC_Exported_Types RAMECC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC Exported Types
* @{
*/
@@ -75,6 +76,7 @@ typedef struct __RAMECC_HandleTypeDef /* Exported constants --------------------------------------------------------*/
/** @defgroup RAMECC_Error_Codes RAMECC Error Codes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_RAMECC_ERROR_NONE 0x00000000U /*!< RAMECC No Error */
@@ -86,6 +88,7 @@ typedef struct __RAMECC_HandleTypeDef */
/** @defgroup RAMECC_Interrupt RAMECC interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RAMECC_IT_GLOBAL_ID 0x10000000UL
@@ -107,6 +110,7 @@ typedef struct __RAMECC_HandleTypeDef */
/** @defgroup RAMECC_FLAG RAMECC Monitor flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RAMECC_FLAG_SINGLEERR_R RAMECC_SR_SEDCF
@@ -120,6 +124,7 @@ typedef struct __RAMECC_HandleTypeDef /* Exported macro ------------------------------------------------------------*/
/** @defgroup RAMECC_Exported_Macros RAMECC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -235,11 +240,13 @@ typedef struct __RAMECC_HandleTypeDef /* Exported functions --------------------------------------------------------*/
/** @defgroup RAMECC_Exported_Functions RAMECC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC Exported functions
* @{
*/
/** @defgroup RAMECC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and de-initialization functions
* @{
*/
@@ -250,6 +257,7 @@ HAL_StatusTypeDef HAL_RAMECC_DeInit (RAMECC_HandleTypeDef *hramecc); */
/** @defgroup RAMECC_Exported_Functions_Group2 monitoring operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief monitoring operation functions
* @{
*/
@@ -265,6 +273,7 @@ HAL_StatusTypeDef HAL_RAMECC_UnRegisterCallback (RAMECC_HandleTypeDef *hramecc) */
/** @defgroup RAMECC_Exported_Functions_Group3 Error informations functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Error informations functions
* @{
*/
@@ -279,6 +288,7 @@ uint32_t HAL_RAMECC_IsECCDoubleErrorDetected (RAMECC_HandleTypeDef *hramecc); */
/** @defgroup RAMECC_Exported_Functions_Group3 Error informations functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Error informations functions
* @{
*/
@@ -293,6 +303,7 @@ uint32_t HAL_RAMECC_GetError (RAMECC_HandleTypeDef *hramecc); */
/* Private Constants -------------------------------------------------------------*/
/** @defgroup RAMECC_Private_Constants RAMECC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC private defines and constants
* @{
*/
@@ -302,6 +313,7 @@ uint32_t HAL_RAMECC_GetError (RAMECC_HandleTypeDef *hramecc); /* Private macros ------------------------------------------------------------*/
/** @defgroup RAMECC_Private_Macros RAMECC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC private macros
* @{
*/
@@ -326,11 +338,13 @@ uint32_t HAL_RAMECC_GetError (RAMECC_HandleTypeDef *hramecc); */
/** @defgroup RAMECC_FLAG RAMECC Monitor flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions ---------------------------------------------------------*/
/** @defgroup RAMECC_Private_Functions RAMECC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RAMECC private functions
* @{
*/
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 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc_ex.h index 0b99087fe7..88191f51d3 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc_ex.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup RCCEx_Exported_Types RCCEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -332,10 +333,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RCCEx_Exported_Constants RCCEx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCCEx_Periph_Clock_Selection RCCEx Periph Clock Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -437,6 +440,7 @@ typedef struct /** @defgroup RCC_PLL2_Clock_Output RCC PLL2 Clock Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL2_DIVP RCC_PLLCFGR_DIVP2EN
@@ -448,6 +452,7 @@ typedef struct */
/** @defgroup RCC_PLL3_Clock_Output RCC PLL3 Clock Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL3_DIVP RCC_PLLCFGR_DIVP3EN
@@ -459,6 +464,7 @@ typedef struct */
/** @defgroup RCC_PLL2_VCI_Range RCC PLL2 VCI Range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL2VCIRANGE_0 RCC_PLLCFGR_PLL2RGE_0 /*!< Clock range frequency between 1 and 2 MHz */
@@ -472,6 +478,7 @@ typedef struct /** @defgroup RCC_PLL2_VCO_Range RCC PLL2 VCO Range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL2VCOWIDE (0x00000000U)
@@ -482,6 +489,7 @@ typedef struct */
/** @defgroup RCC_PLL3_VCI_Range RCC PLL3 VCI Range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL3VCIRANGE_0 RCC_PLLCFGR_PLL3RGE_0 /*!< Clock range frequency between 1 and 2 MHz */
@@ -495,6 +503,7 @@ typedef struct /** @defgroup RCC_PLL3_VCO_Range RCC PLL3 VCO Range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_PLL3VCOWIDE (0x00000000U)
@@ -505,6 +514,7 @@ typedef struct */
/** @defgroup RCCEx_USART16_Clock_Source RCCEx USART1/6 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_USART16SEL)
@@ -542,6 +552,7 @@ typedef struct */
/** @defgroup RCCEx_USART1_Clock_Source RCCEx USART1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_USART1CLKSOURCE_D2PCLK2 RCC_USART16CLKSOURCE_D2PCLK2
@@ -555,6 +566,7 @@ typedef struct */
/** @defgroup RCCEx_USART6_Clock_Source RCCEx USART6 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_USART6CLKSOURCE_D2PCLK2 RCC_USART16CLKSOURCE_D2PCLK2
@@ -570,6 +582,7 @@ typedef struct #if defined(UART9)
/** @defgroup RCCEx_UART9_Clock_Source RCCEx UART9 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_UART9CLKSOURCE_D2PCLK2 RCC_USART16CLKSOURCE_D2PCLK2
@@ -585,6 +598,7 @@ typedef struct #if defined(USART10)
/** @defgroup RCCEx_USART10_Clock_Source RCCEx USART10 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_USART10CLKSOURCE_D2PCLK2 RCC_USART16CLKSOURCE_D2PCLK2
@@ -599,6 +613,7 @@ typedef struct #endif /* USART10 */
/** @defgroup RCCEx_USART234578_Clock_Source RCCEx USART2/3/4/5/7/8 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_USART28SEL)
@@ -626,6 +641,7 @@ typedef struct */
/** @defgroup RCCEx_USART2_Clock_Source RCCEx USART2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_USART2CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -640,6 +656,7 @@ typedef struct */
/** @defgroup RCCEx_USART3_Clock_Source RCCEx USART3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_USART3CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -654,6 +671,7 @@ typedef struct */
/** @defgroup RCCEx_UART4_Clock_Source RCCEx UART4 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_UART4CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -668,6 +686,7 @@ typedef struct */
/** @defgroup RCCEx_UART5_Clock_Source RCCEx UART5 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_UART5CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -682,6 +701,7 @@ typedef struct */
/** @defgroup RCCEx_UART7_Clock_Source RCCEx UART7 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_UART7CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -696,6 +716,7 @@ typedef struct */
/** @defgroup RCCEx_UART8_Clock_Source RCCEx UART8 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_UART8CLKSOURCE_D2PCLK1 RCC_USART234578CLKSOURCE_D2PCLK1
@@ -710,6 +731,7 @@ typedef struct */
/** @defgroup RCCEx_LPUART1_Clock_Source RCCEx LPUART1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_LPUART1SEL)
@@ -737,6 +759,7 @@ typedef struct */
/** @defgroup RCCEx_I2C123_Clock_Source RCCEx I2C1/2/3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (RCC_D2CCIP2R_I2C123SEL)
@@ -757,6 +780,7 @@ typedef struct */
/** @defgroup RCCEx_I2C1_Clock_Source RCCEx I2C1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_I2C1CLKSOURCE_D2PCLK1 RCC_I2C123CLKSOURCE_D2PCLK1
@@ -769,6 +793,7 @@ typedef struct */
/** @defgroup RCCEx_I2C2_Clock_Source RCCEx I2C2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_I2C2CLKSOURCE_D2PCLK1 RCC_I2C123CLKSOURCE_D2PCLK1
@@ -781,6 +806,7 @@ typedef struct */
/** @defgroup RCCEx_I2C3_Clock_Source RCCEx I2C3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_I2C3CLKSOURCE_D2PCLK1 RCC_I2C123CLKSOURCE_D2PCLK1
@@ -793,6 +819,7 @@ typedef struct */
/** @defgroup RCCEx_I2C4_Clock_Source RCCEx I2C4 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_I2C4SEL)
@@ -814,6 +841,7 @@ typedef struct */
/** @defgroup RCCEx_RNG_Clock_Source RCCEx RNG Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_RNGSEL)
@@ -834,6 +862,7 @@ typedef struct #if defined(HRTIM1)
/** @defgroup RCCEx_HRTIM1_Clock_Source RCC Extended HRTIM1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_HRTIM1CLK_TIMCLK (0x00000000U)
@@ -845,6 +874,7 @@ typedef struct #endif /*HRTIM1*/
/** @defgroup RCCEx_USB_Clock_Source RCCEx USB Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_USBSEL)
@@ -862,6 +892,7 @@ typedef struct */
/** @defgroup RCCEx_SAI1_Clock_Source SAI1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SAI1SEL)
@@ -883,6 +914,7 @@ typedef struct #if defined(SAI3)
/** @defgroup RCCEx_SAI23_Clock_Source SAI2/3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI23CLKSOURCE_PLL (0x00000000U)
@@ -895,6 +927,7 @@ typedef struct */
/** @defgroup RCCEx_SAI2_Clock_Source SAI2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI2CLKSOURCE_PLL RCC_SAI23CLKSOURCE_PLL
@@ -908,6 +941,7 @@ typedef struct */
/** @defgroup RCCEx_SAI3_Clock_Source SAI3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI3CLKSOURCE_PLL RCC_SAI23CLKSOURCE_PLL
@@ -922,6 +956,7 @@ typedef struct #if defined(RCC_CDCCIP1R_SAI2ASEL)
/** @defgroup RCCEx_SAI2_Clock_A Source SAI2A Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI2ACLKSOURCE_PLL (0x00000000U)
@@ -937,6 +972,7 @@ typedef struct #if defined(RCC_CDCCIP1R_SAI2BSEL)
/** @defgroup RCCEx_SAI2_Block_B Clock_Source SAI2B Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI2BCLKSOURCE_PLL (0x00000000U)
@@ -952,6 +988,7 @@ typedef struct /** @defgroup RCCEx_SPI123_Clock_Source SPI1/2/3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPI123SEL)
@@ -972,6 +1009,7 @@ typedef struct */
/** @defgroup RCCEx_SPI1_Clock_Source SPI1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SPI1CLKSOURCE_PLL RCC_SPI123CLKSOURCE_PLL
@@ -985,6 +1023,7 @@ typedef struct */
/** @defgroup RCCEx_SPI2_Clock_Source SPI2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SPI2CLKSOURCE_PLL RCC_SPI123CLKSOURCE_PLL
@@ -998,6 +1037,7 @@ typedef struct */
/** @defgroup RCCEx_SPI3_Clock_Source SPI3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SPI3CLKSOURCE_PLL RCC_SPI123CLKSOURCE_PLL
@@ -1011,6 +1051,7 @@ typedef struct */
/** @defgroup RCCEx_SPI45_Clock_Source SPI4/5 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPI45SEL)
@@ -1037,6 +1078,7 @@ typedef struct */
/** @defgroup RCCEx_SPI4_Clock_Source SPI4 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SPI4CLKSOURCE_D2PCLK1 RCC_SPI45CLKSOURCE_D2PCLK1
@@ -1051,6 +1093,7 @@ typedef struct */
/** @defgroup RCCEx_SPI5_Clock_Source SPI5 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SPI5CLKSOURCE_D2PCLK1 RCC_SPI45CLKSOURCE_D2PCLK1
@@ -1065,6 +1108,7 @@ typedef struct */
/** @defgroup RCCEx_SPI6_Clock_Source SPI6 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_SPI6SEL)
@@ -1095,6 +1139,7 @@ typedef struct #if defined(SAI4_Block_A)
/** @defgroup RCCEx_SAI4A_Clock_Source SAI4A Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI4ACLKSOURCE_PLL (0x00000000U)
@@ -1112,6 +1157,7 @@ typedef struct #if defined(SAI4_Block_B)
/** @defgroup RCCEx_SAI4B_Clock_Source SAI4B Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_SAI4BCLKSOURCE_PLL (0x00000000U)
@@ -1127,6 +1173,7 @@ typedef struct /** @defgroup RCCEx_LPTIM1_Clock_Source RCCEx LPTIM1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_LPTIM1SEL)
@@ -1155,6 +1202,7 @@ typedef struct */
/** @defgroup RCCEx_LPTIM2_Clock_Source RCCEx LPTIM2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_LPTIM2SEL)
@@ -1182,6 +1230,7 @@ typedef struct */
/** @defgroup RCCEx_LPTIM345_Clock_Source RCCEx LPTIM3/4/5 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_LPTIM345SEL)
@@ -1209,6 +1258,7 @@ typedef struct */
/** @defgroup RCCEx_LPTIM3_Clock_Source RCCEx LPTIM3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_LPTIM3CLKSOURCE_D3PCLK1 RCC_LPTIM345CLKSOURCE_D3PCLK1
@@ -1223,6 +1273,7 @@ typedef struct */
#if defined(LPTIM4)
/** @defgroup RCCEx_LPTIM4_Clock_Source RCCEx LPTIM4 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_LPTIM4CLKSOURCE_D3PCLK1 RCC_LPTIM345CLKSOURCE_D3PCLK1
@@ -1238,6 +1289,7 @@ typedef struct #if defined(LPTIM5)
/** @defgroup RCCEx_LPTIM5_Clock_Source RCCEx LPTIM5 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_LPTIM5CLKSOURCE_D3PCLK1 RCC_LPTIM345CLKSOURCE_D3PCLK1
@@ -1254,6 +1306,7 @@ typedef struct #if defined(QUADSPI)
/** @defgroup RCCEx_QSPI_Clock_Source RCCEx QSPI Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_QSPICLKSOURCE_D1HCLK (0x00000000U)
@@ -1269,6 +1322,7 @@ typedef struct #if defined(OCTOSPI1) || defined(OCTOSPI2)
/** @defgroup RCCEx_OSPI_Clock_Source RCCEx OSPI Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_OSPICLKSOURCE_CDHCLK (0x00000000U)
@@ -1286,6 +1340,7 @@ typedef struct #if defined(DSI)
/** @defgroup RCCEx_DSI_Clock_Source RCCEx DSI Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_DSICLKSOURCE_PHY (0x00000000U)
@@ -1297,6 +1352,7 @@ typedef struct #endif /* DSI */
/** @defgroup RCCEx_FMC_Clock_Source RCCEx FMC Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_FMCSEL)
@@ -1320,6 +1376,7 @@ typedef struct #if defined(FDCAN1) || defined(FDCAN2)
/** @defgroup RCCEx_FDCAN_Clock_Source RCCEx FDCAN Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_FDCANSEL)
@@ -1338,6 +1395,7 @@ typedef struct /** @defgroup RCCEx_SDMMC_Clock_Source RCCEx SDMMC Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_SDMMCSEL)
@@ -1353,6 +1411,7 @@ typedef struct /** @defgroup RCCEx_ADC_Clock_Source RCCEx ADC Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_ADCSEL_0)
@@ -1369,6 +1428,7 @@ typedef struct */
/** @defgroup RCCEx_SWPMI1_Clock_Source RCCEx SWPMI1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SWPSEL)
@@ -1385,6 +1445,7 @@ typedef struct */
/** @defgroup RCCEx_DFSDM1_Clock_Source RCCEx DFSDM1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_DFSDM1SEL)
@@ -1402,6 +1463,7 @@ typedef struct #if defined(DFSDM2_BASE)
/** @defgroup RCCEx_DFSDM2_Clock_Source RCCEx DFSDM2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_DFSDM2CLKSOURCE_SRDPCLK4 (0x00000000U)
@@ -1414,6 +1476,7 @@ typedef struct #endif /* DFSDM2 */
/** @defgroup RCCEx_SPDIFRX_Clock_Source RCCEx SPDIFRX Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPDIFSEL_0)
@@ -1432,6 +1495,7 @@ typedef struct */
/** @defgroup RCCEx_CEC_Clock_Source RCCEx CEC Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_CECSEL_0)
@@ -1449,6 +1513,7 @@ typedef struct /** @defgroup RCCEx_CLKP_Clock_Source RCCEx CLKP Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_CKPERSEL_0)
@@ -1465,6 +1530,7 @@ typedef struct */
/** @defgroup RCCEx_TIM_Prescaler_Selection RCCEx TIM Prescaler Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_TIMPRES_DESACTIVATED (0x00000000U)
@@ -1477,6 +1543,7 @@ typedef struct #if defined(DUAL_CORE)
/** @defgroup RCCEx_RCC_BootCx RCCEx RCC BootCx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_BOOT_C1 RCC_GCR_BOOT_C1
@@ -1489,6 +1556,7 @@ typedef struct #if defined(DUAL_CORE)
/** @defgroup RCCEx_RCC_WWDGx RCCEx RCC WWDGx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_WWDG1 RCC_GCR_WW1RSC
@@ -1501,6 +1569,7 @@ typedef struct #else
/** @defgroup RCCEx_RCC_WWDGx RCCEx RCC WWDGx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_WWDG1 RCC_GCR_WW1RSC
@@ -1512,6 +1581,7 @@ typedef struct #endif /*DUAL_CORE*/
/** @defgroup RCCEx_EXTI_LINE_LSECSS RCC LSE CSS external interrupt line
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_EXTI_LINE_LSECSS EXTI_IMR1_IM18 /*!< External interrupt line 19 connected to the LSE CSS EXTI Line */
@@ -1520,6 +1590,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_Status RCCEx CRS Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_NONE (0x00000000U)
@@ -1534,6 +1605,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_SynchroSource RCCEx CRS SynchroSource
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_SYNC_SOURCE_PIN (0x00000000U) /*!< Synchro Signal source external pin, Available on STM32H7 Rev.B and above devices only */
@@ -1547,6 +1619,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_SynchroDivider RCCEx CRS SynchroDivider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_SYNC_DIV1 (0x00000000U) /*!< Synchro Signal not divided (default) */
@@ -1562,6 +1635,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_SynchroPolarity RCCEx CRS SynchroPolarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_SYNC_POLARITY_RISING (0x00000000U) /*!< Synchro Active on rising edge (default) */
@@ -1571,6 +1645,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_ReloadValueDefault RCCEx CRS ReloadValueDefault
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_RELOADVALUE_DEFAULT (0x0000BB7FU) /*!< The reset value of the RELOAD field corresponds
@@ -1580,6 +1655,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_ErrorLimitDefault RCCEx CRS ErrorLimitDefault
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_ERRORLIMIT_DEFAULT (0x00000022U) /*!< Default Frequency error limit */
@@ -1588,6 +1664,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_HSI48CalibrationDefault RCCEx CRS HSI48CalibrationDefault
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_HSI48CALIBRATION_DEFAULT (0x00000020U) /*!< The default value is 32, which corresponds to the middle of the trimming interval.
@@ -1598,6 +1675,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_FreqErrorDirection RCCEx CRS FreqErrorDirection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_FREQERRORDIR_UP (0x00000000U) /*!< Upcounting direction, the actual frequency is above the target */
@@ -1607,6 +1685,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_Interrupt_Sources RCCEx CRS Interrupt Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_IT_SYNCOK CRS_CR_SYNCOKIE /*!< SYNC event OK */
@@ -1622,6 +1701,7 @@ typedef struct */
/** @defgroup RCCEx_CRS_Flags RCCEx CRS Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RCC_CRS_FLAG_SYNCOK CRS_ISR_SYNCOKF /*!< SYNC event OK flag */
@@ -1644,6 +1724,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup RCCEx_Exported_Macros RCCEx Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3375,6 +3456,7 @@ typedef struct #if defined(HRTIM1)
/** @defgroup RCCEx_HRTIMx_Clock_Config RCC Extended HRTIMx Clock Config
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Macro to configure the HRTIM1 prescaler clock source.
@@ -3644,6 +3726,7 @@ typedef struct } while(0)
/** @defgroup RCCEx_CRS_Extended_Features RCCEx CRS Extended Features
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3756,6 +3839,7 @@ void HAL_RCCEx_CRS_ErrorCallback(uint32_t Error); * @{
*/
/** @defgroup RCCEx_IS_RCC_Definitions RCC Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h index 2419609332..054fd94bb6 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng.h @@ -35,6 +35,7 @@ extern "C" { #if defined (RNG)
/** @defgroup RNG RNG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RNG HAL module driver
* @{
*/
@@ -42,10 +43,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup RNG_Exported_Types RNG Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_Exported_Types_Group1 RNG Init Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -58,6 +61,7 @@ typedef struct */
/** @defgroup RNG_Exported_Types_Group2 RNG State Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -75,6 +79,7 @@ typedef enum */
/** @defgroup RNG_Exported_Types_Group3 RNG Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
@@ -136,10 +141,12 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t /* Exported constants --------------------------------------------------------*/
/** @defgroup RNG_Exported_Constants RNG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_Exported_Constants_Group1 RNG Interrupt definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_IT_DRDY RNG_SR_DRDY /*!< Data Ready interrupt */
@@ -150,6 +157,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t */
/** @defgroup RNG_Exported_Constants_Group2 RNG Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_FLAG_DRDY RNG_SR_DRDY /*!< Data ready */
@@ -160,6 +168,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t */
/** @defgroup RNG_Exported_Constants_Group3 RNG Clock Error Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_CED_ENABLE 0x00000000U /*!< Clock error detection Enabled */
@@ -169,6 +178,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t */
/** @defgroup RNG_Error_Definition RNG Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_RNG_ERROR_NONE 0x00000000U /*!< No error */
@@ -189,6 +199,7 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t /* Exported macros -----------------------------------------------------------*/
/** @defgroup RNG_Exported_Macros RNG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -290,10 +301,12 @@ typedef void (*pRNG_ReadyDataCallbackTypeDef)(RNG_HandleTypeDef *hrng, uint32_t #endif /* CONDRST */
/* Exported functions --------------------------------------------------------*/
/** @defgroup RNG_Exported_Functions RNG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_Exported_Functions_Group1 Initialization and configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RNG_Init(RNG_HandleTypeDef *hrng);
@@ -315,6 +328,7 @@ HAL_StatusTypeDef HAL_RNG_UnRegisterReadyDataCallback(RNG_HandleTypeDef *hrng); */
/** @defgroup RNG_Exported_Functions_Group2 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber(RNG_HandleTypeDef *hrng, uint32_t *random32bit);
@@ -330,6 +344,7 @@ void HAL_RNG_ReadyDataCallback(RNG_HandleTypeDef *hrng, uint32_t random32bit); */
/** @defgroup RNG_Exported_Functions_Group3 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_RNG_StateTypeDef HAL_RNG_GetState(RNG_HandleTypeDef *hrng);
@@ -344,6 +359,7 @@ uint32_t HAL_RNG_GetError(RNG_HandleTypeDef *hrng); /* Private macros ------------------------------------------------------------*/
/** @defgroup RNG_Private_Macros RNG Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_RNG_IT(IT) (((IT) == RNG_IT_CEI) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng_ex.h index 69a97d4cba..054cce6e09 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rng_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rng_ex.h @@ -36,12 +36,14 @@ extern "C" { #if defined (RNG_CR_CONDRST)
/** @defgroup RNGEx RNGEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RNG Extension HAL module driver
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup RNGEx_Exported_Types RNGEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief RNGEx Exported types
* @{
*/
@@ -67,10 +69,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RNGEX_Exported_Constants RNGEX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNGEX_Clock_Divider_Factor Value used to configure an internal
+ * @ingroup RTEMSBSPsARMSTM32H7 * programmable divider acting on the incoming RNG clock
* @{
*/
@@ -110,6 +114,7 @@ typedef struct */
/** @defgroup RNGEX_NIST_Compliance NIST Compliance configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RNG_NIST_COMPLIANT (0x00000000UL) /*!< NIST compliant configuration*/
@@ -125,6 +130,7 @@ typedef struct /* Private types -------------------------------------------------------------*/
/** @defgroup RNGEx_Private_Types RNGEx Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -134,6 +140,7 @@ typedef struct /* Private variables ---------------------------------------------------------*/
/** @defgroup RNGEx_Private_Variables RNGEx Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -143,6 +150,7 @@ typedef struct /* Private constants ---------------------------------------------------------*/
/** @defgroup RNGEx_Private_Constants RNGEx Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -152,6 +160,7 @@ typedef struct /* Private macros ------------------------------------------------------------*/
/** @defgroup RNGEx_Private_Macros RNGEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -189,6 +198,7 @@ typedef struct /* Private functions ---------------------------------------------------------*/
/** @defgroup RNGEx_Private_Functions RNGEx Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -198,6 +208,7 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RNGEx_Exported_Functions RNGEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h index ddc3eab005..224c6cef85 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc.h @@ -33,11 +33,13 @@ extern "C" { */
/** @defgroup RTC RTC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup RTC_Exported_Types RTC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -283,10 +285,12 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup RTC_Exported_Constants RTC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTC_Hour_Formats_Definitions RTC Hour Formats Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_HOURFORMAT_24 0x00000000u
@@ -296,6 +300,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Output_selection_Definitions RTC Output Selection Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_OUTPUT_DISABLE 0x00000000u
@@ -310,6 +315,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_OUTPUT_POLARITY_HIGH 0x00000000u
@@ -319,6 +325,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPALRM_TYPE)
@@ -337,6 +344,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Output_PullUp_ALARM_OUT RTC Output Pull-Up ALARM OUT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPALRM_PU)
@@ -348,6 +356,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Output_ALARM_OUT_Remap RTC Output ALARM OUT Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_OUT2EN)
@@ -364,6 +373,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_HOURFORMAT12_AM ((uint8_t)0x00)
@@ -373,6 +383,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_DayLightSaving_Definitions RTC DayLight Saving Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_DAYLIGHTSAVING_SUB1H RTC_CR_SUB1H
@@ -383,6 +394,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_StoreOperation_Definitions RTC Store Operation Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_STOREOPERATION_RESET 0x00000000u
@@ -392,6 +404,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Input_parameter_format_definitions RTC Input Parameter Format Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_FORMAT_BIN 0x00000000u
@@ -401,6 +414,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions (in BCD format)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_MONTH_JANUARY ((uint8_t)0x01)
@@ -421,6 +435,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_WEEKDAY_MONDAY ((uint8_t)0x01)
@@ -436,6 +451,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_AlarmDateWeekDay_Definitions RTC Alarm Date WeekDay Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ALARMDATEWEEKDAYSEL_DATE 0x00000000u
@@ -446,6 +462,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_AlarmMask_Definitions RTC Alarm Mask Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ALARMMASK_NONE 0x00000000u
@@ -462,6 +479,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ALARM_A RTC_CR_ALRAE
@@ -471,6 +489,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/*!< All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm */
@@ -511,6 +530,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_IT_TS RTC_CR_TSIE /*!< Enable Timestamp Interrupt */
@@ -522,6 +542,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Flags_Definitions RTC Flags Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_ICSR_RECALPF)
@@ -571,6 +592,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Clear_Flags_Definitions RTC Clear Flags Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_SCR_CITSF)
@@ -596,6 +618,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to */
/** @defgroup RTC_Flags_Definitions RTC Flags Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_ISR_RECALPF)
@@ -650,6 +673,7 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported macros -----------------------------------------------------------*/
/** @defgroup RTC_Exported_Macros RTC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -999,10 +1023,12 @@ typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to /* Exported functions --------------------------------------------------------*/
/** @defgroup RTC_Exported_Functions RTC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization and de-initialization functions ****************************/
@@ -1022,6 +1048,7 @@ HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_Ca */
/** @defgroup RTC_Exported_Functions_Group2 RTC Time and Date functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* RTC Time and Date functions ************************************************/
@@ -1034,6 +1061,7 @@ HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDat */
/** @defgroup RTC_Exported_Functions_Group3 RTC Alarm functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* RTC Alarm functions ********************************************************/
@@ -1049,6 +1077,7 @@ HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t T */
/** @defgroup RTC_Exported_Functions_Group4 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Peripheral Control functions ***********************************************/
@@ -1058,6 +1087,7 @@ HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc); */
/** @defgroup RTC_Exported_Functions_Group5 Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Peripheral State functions *************************************************/
@@ -1074,6 +1104,7 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RTC_Private_Constants RTC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Masks Definition */
@@ -1105,10 +1136,12 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private macros ------------------------------------------------------------*/
/** @defgroup RTC_Private_Macros RTC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTC_IS_RTC_Definitions RTC Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1214,6 +1247,7 @@ HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc); /* Private functions -------------------------------------------------------------*/
/** @defgroup RTC_Private_Functions RTC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h index a9159c55f1..c621f78c30 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rtc_ex.h @@ -33,16 +33,19 @@ extern "C" { */
/** @defgroup RTCEx RTCEx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Types RTCEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTCEx_Tamper_structure_definition RTC Tamper structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -83,6 +86,7 @@ typedef struct #if defined(TAMP_CR1_ITAMP1E)
/** @defgroup RTCEx_Internal_Tamper_structure_definition RTCEx Internal Tamper structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -100,6 +104,7 @@ typedef struct #if defined(TAMP_ATCR1_TAMP1AM)
/** @defgroup RTCEx_Active_Seed_Size Seed size Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_SEED_NB_UINT32 4U
@@ -108,6 +113,7 @@ typedef struct */
/** @defgroup RTCEx_Active_Tampers_Number Active Tampers number Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TAMP_NB 3u
@@ -116,6 +122,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_structures_definition RTC Active Tamper structures definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -174,6 +181,7 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Constants RTC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -182,6 +190,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Backup_Registers_Number_Definitions RTC Backup Registers Number Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_BKP_NUMBER)
@@ -195,6 +204,7 @@ typedef struct */
/** @defgroup RTCEx_Backup_Registers_Definitions RTC Backup Registers Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_BKP_DR0 0x00u
@@ -238,6 +248,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_TimeStamp_Edges_definitions RTC TimeStamp Edges Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 *
* @{
*/
@@ -248,6 +259,7 @@ typedef struct */
/** @defgroup RTCEx_TimeStamp_Pin_Selection RTC TimeStamp Pin Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TIMESTAMPPIN_DEFAULT 0x00000000u
@@ -261,6 +273,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Tamper_Pins_Definitions RTC Tamper Pins Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR1_TAMP1E)
@@ -289,6 +302,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Interrupt_Definitions RTC Tamper Interrupts Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_IER_TAMP1IE)
@@ -323,6 +337,7 @@ typedef struct */
/** @defgroup RTCEx_Internal_Tamper_Pins_Definitions RTCEx Internal Tamper Pins Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR1_ITAMP1E)
@@ -355,6 +370,7 @@ typedef struct */
/** @defgroup RTCEx_Internal_Tamper_Interrupt_Definitions RTC Internal Tamper Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_IER_ITAMP1IE)
@@ -383,6 +399,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Trigger_Definitions RTC Tamper Triggers Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_TAMPERTRIGGER_RISINGEDGE 0x01u /*!< Warning : Filter must be RTC_TAMPERFILTER_DISABLE */
@@ -418,6 +435,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_EraseBackUp_Definitions RTC Tamper EraseBackUp Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR2_TAMP1NOERASE)
@@ -457,6 +475,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_MaskFlag_Definitions RTC Tamper Mask Flag Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_CR2_TAMP1MSK)
@@ -496,6 +515,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Filter_Definitions RTC Tamper Filter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPFLT)
@@ -527,6 +547,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Sampling_Frequencies_Definitions RTC Tamper Sampling Frequencies Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPFREQ)
@@ -574,6 +595,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Pin_Precharge_Duration_Definitions RTC Tamper Pin Precharge Duration Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPPRCH)
@@ -605,6 +627,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_TimeStampOnTamperDetection_Definitions RTC Tamper TimeStamp On Tamper Detection Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPTS)
@@ -622,6 +645,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Pull_UP_Definitions RTC Tamper Pull Up Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_FLTCR_TAMPPUDIS)
@@ -639,6 +663,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_DetectionOutput_Definitions RTC Tamper Detection Ouput Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPOE)
@@ -651,6 +676,7 @@ typedef struct */
/** @defgroup RTC_Tamper_Flags_Definitions RTC Tamper Flags Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(TAMP_SR_TAMP1F)
@@ -677,6 +703,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Enable RTCEx_ActiveTamper_Enable Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_ENABLE 1u
@@ -686,6 +713,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Interrupt RTCEx_ActiveTamper_Interrupt Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_INTERRUPT_ENABLE 1u
@@ -695,6 +723,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Filter RTCEx_ActiveTamper_Filter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_FILTER_ENABLE TAMP_ATCR1_FLTEN
@@ -704,6 +733,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Async_prescaler RTC Active_Tamper_Asynchronous_Prescaler clock Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_ASYNCPRES_RTCCLK 0u /*!< RTCCLK */
@@ -719,6 +749,7 @@ typedef struct */
/** @defgroup RTCEx_ActiveTamper_Sel RTC Active Tamper selection Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_ATAMP_1 0u /*!< Tamper 1 */
@@ -734,6 +765,7 @@ typedef struct */
/** @defgroup RTCEx_Tamper_Registers_Offset RTC Tamper Registers Offset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (TAMP_CR1_TAMP1E)
@@ -749,6 +781,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Wakeup_Timer_Definitions RTC Wakeup Timer Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_WAKEUPCLOCK_RTCCLK_DIV16 0x00000000u
@@ -766,6 +799,7 @@ typedef struct /* ========================================================================== */
/** @defgroup RTCEx_Smooth_calib_period_Definitions RTC Smooth Calib Period Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SMOOTHCALIB_PERIOD_32SEC 0x00000000u /*!< If RTCCLK = 32768 Hz, Smooth calibration
@@ -779,6 +813,7 @@ typedef struct */
/** @defgroup RTCEx_Smooth_calib_Plus_pulses_Definitions RTC Smooth Calib Plus pulses Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SMOOTHCALIB_PLUSPULSES_SET RTC_CALR_CALP /*!< The number of RTCCLK pulses added
@@ -791,6 +826,7 @@ typedef struct */
/** @defgroup RTCEx_Calib_Output_selection_Definitions RTC Calib Output Selection Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_CALIBOUTPUT_512HZ 0x00000000u
@@ -800,6 +836,7 @@ typedef struct */
/** @defgroup RTCEx_Add_1_Second_Parameter_Definitions RTC Add 1 Second Parameter Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_SHIFTADD1S_RESET 0x00000000u
@@ -815,6 +852,7 @@ typedef struct /* Exported macros -----------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Macros RTC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1762,6 +1800,7 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RTCEx_Exported_Functions RTC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1772,6 +1811,7 @@ typedef struct /* RTC TimeStamp functions ****************************************************/
/** @defgroup RTCEx_Exported_Functions_Group1 Extended RTC TimeStamp functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp(RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin);
@@ -1794,6 +1834,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent(RTC_HandleTypeDef *hrtc, uint3 /* RTC Tamper functions *******************************************************/
/** @defgroup RTCEx_Exported_Functions_Group5 Extended RTC Tamper functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetTamper(RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper);
@@ -1847,6 +1888,7 @@ HAL_StatusTypeDef HAL_RTCEx_DeactivateActiveTampers(RTC_HandleTypeDef *hrtc); /* RTC Wake-up functions ******************************************************/
/** @defgroup RTCEx_Exported_Functions_Group2 Extended RTC Wake-up functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer(RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock);
@@ -1867,6 +1909,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent(RTC_HandleTypeDef *hrtc, uin /* Extended RTC Backup registers functions ************************************/
/** @defgroup RTCEx_Exported_Functions_Group6 Extended RTC Backup register functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void HAL_RTCEx_BKUPWrite(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data);
@@ -1882,6 +1925,7 @@ uint32_t HAL_RTCEx_BKUPRead(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister); /* Extended RTC Peripheral Control functions **********************************/
/** @defgroup RTCEx_Exported_Functions_Group3 Extended Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib(RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmoothCalibMinusPulsesValue);
@@ -1903,6 +1947,7 @@ HAL_StatusTypeDef HAL_RTCEx_MonotonicCounterGet(RTC_HandleTypeDef *hrtc, uint32_ /* Extended RTC features functions *******************************************/
/** @defgroup RTCEx_Exported_Functions_Group4 Extended features functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1920,6 +1965,7 @@ HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent(RTC_HandleTypeDef *hrtc, uint32_t /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RTCEx_Private_Constants RTC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT EXTI_IMR1_IM18 /*!< External interrupt line 18 Connected to the RTC Tamper and Time Stamp events */
@@ -1935,10 +1981,12 @@ HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent(RTC_HandleTypeDef *hrtc, uint32_t /* Private macros ------------------------------------------------------------*/
/** @defgroup RTCEx_Private_Macros RTC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTCEx_IS_RTC_Definitions Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h index a8dd6d5680..0dc6f0fa0f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup SAI_Exported_Types SAI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -59,6 +60,7 @@ typedef enum typedef void (*SAIcallback)(void);
/** @defgroup SAI_PDM_Structure_definition SAI PDM Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI PDM Init structure definition
* @{
*/
@@ -75,6 +77,7 @@ typedef struct */
/** @defgroup SAI_Init_Structure_definition SAI Init Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Init Structure definition
* @{
*/
@@ -153,6 +156,7 @@ typedef struct */
/** @defgroup SAI_Frame_Structure_definition SAI Frame Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Frame Init structure definition
* @{
*/
@@ -185,6 +189,7 @@ typedef struct */
/** @defgroup SAI_Slot_Structure_definition SAI Slot Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI Block Slot Init Structure definition
* @{
*/
@@ -207,6 +212,7 @@ typedef struct */
/** @defgroup SAI_Handle_Structure_definition SAI Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SAI handle Structure definition
* @{
*/
@@ -281,10 +287,12 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); /* Exported constants --------------------------------------------------------*/
/** @defgroup SAI_Exported_Constants SAI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SAI_Error_Code SAI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SAI_ERROR_NONE 0x00000000U /*!< No error */
@@ -304,6 +312,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_SyncExt SAI External synchronisation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SYNCEXT_DISABLE 0U
@@ -314,6 +323,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_MckOutput SAI Block Master Clock Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MCK_OUTPUT_DISABLE 0x00000000U
@@ -323,6 +333,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Protocol SAI Supported protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_I2S_STANDARD 0U
@@ -335,6 +346,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Protocol_DataSize SAI protocol data size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_PROTOCOL_DATASIZE_16BIT 0U
@@ -346,6 +358,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Audio_Frequency SAI Audio Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_AUDIO_FREQUENCY_192K 192000U
@@ -363,6 +376,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mck_OverSampling SAI Block Master Clock OverSampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MCK_OVERSAMPLING_DISABLE 0x00000000U
@@ -372,6 +386,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_PDM_ClockEnable SAI PDM Clock Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_PDM_CLOCK1_ENABLE SAI_PDMCR_CKEN1
@@ -381,6 +396,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mode SAI Block Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MODEMASTER_TX 0x00000000U
@@ -393,6 +409,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Protocol SAI Block Protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FREE_PROTOCOL 0x00000000U
@@ -403,6 +420,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Data_Size SAI Block Data Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_DATASIZE_8 SAI_xCR1_DS_1
@@ -416,6 +434,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_MSB_LSB_transmission SAI Block MSB LSB transmission
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIRSTBIT_MSB 0x00000000U
@@ -425,6 +444,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Clock_Strobing SAI Block Clock Strobing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_CLOCKSTROBING_FALLINGEDGE 0U
@@ -434,6 +454,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Synchronization SAI Block Synchronization
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_ASYNCHRONOUS 0U /*!< Asynchronous */
@@ -453,6 +474,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Output_Drive SAI Block Output Drive
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_OUTPUTDRIVE_DISABLE 0x00000000U
@@ -462,6 +484,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_NoDivider SAI Block NoDivider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_MASTERDIVIDER_ENABLE 0x00000000U
@@ -471,6 +494,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Definition SAI Block FS Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_STARTFRAME 0x00000000U
@@ -480,6 +504,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Polarity SAI Block FS Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_ACTIVE_LOW 0x00000000U
@@ -489,6 +514,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_FS_Offset SAI Block FS Offset
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FS_FIRSTBIT 0x00000000U
@@ -498,6 +524,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Slot_Size SAI Block Slot Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SLOTSIZE_DATASIZE 0x00000000U
@@ -508,6 +535,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Slot_Active SAI Block Slot Active
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_SLOT_NOTACTIVE 0x00000000U
@@ -533,6 +561,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Mono_Stereo_Mode SAI Mono Stereo Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_STEREOMODE 0x00000000U
@@ -542,6 +571,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_TRIState_Management SAI TRIState Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_OUTPUT_NOTRELEASED 0x00000000U
@@ -551,6 +581,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Fifo_Threshold SAI Block Fifo Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIFOTHRESHOLD_EMPTY 0x00000000U
@@ -563,6 +594,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Companding_Mode SAI Block Companding Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_NOCOMPANDING 0x00000000U
@@ -575,6 +607,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Mute_Value SAI Block Mute Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_ZERO_VALUE 0x00000000U
@@ -584,6 +617,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Interrupts_Definition SAI Block Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_IT_OVRUDR SAI_xIMR_OVRUDRIE
@@ -598,6 +632,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Flags_Definition SAI Block Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FLAG_OVRUDR SAI_xSR_OVRUDR
@@ -612,6 +647,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); */
/** @defgroup SAI_Block_Fifo_Status_Level SAI Block Fifo Status Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SAI_FIFOSTATUS_EMPTY 0x00000000U
@@ -630,6 +666,7 @@ typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SAI_Exported_Macros SAI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific configurations
* @{
*/
@@ -959,6 +996,7 @@ uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai); /* Private functions ---------------------------------------------------------*/
/** @defgroup SAI_Private_Functions SAI Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai_ex.h index 40245731d1..0566e42b7b 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sai_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sai_ex.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup SAIEx_Exported_Types SAIEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h index b69533120f..caeff95153 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h @@ -36,16 +36,19 @@ */
/** @defgroup SD SD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SD HAL module driver
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup SD_Exported_Types SD Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -64,6 +67,7 @@ typedef enum */
/** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef uint32_t HAL_SD_CardStateTypeDef;
@@ -82,6 +86,7 @@ typedef uint32_t HAL_SD_CardStateTypeDef; */
/** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SD_InitTypeDef SDMMC_InitTypeDef
@@ -171,6 +176,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -218,6 +224,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -239,6 +246,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -263,6 +271,7 @@ typedef struct #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
/** @defgroup SD_Exported_Types_Group7 SD Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -284,6 +293,7 @@ typedef enum */
/** @defgroup SD_Exported_Types_Group8 SD Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef void (*pSD_CallbackTypeDef) (SD_HandleTypeDef *hsd);
@@ -300,12 +310,14 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported constants --------------------------------------------------------*/
/** @defgroup SD_Exported_Constants Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
/** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
@@ -353,6 +365,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SD_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
@@ -368,6 +381,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CARD_NORMAL_SPEED ((uint32_t)0x00000000U) /*!< Normal Speed Card <12.5Mo/s , Spec Version 1.01 */
@@ -384,6 +398,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CARD_V1_X ((uint32_t)0x00000000U)
@@ -398,6 +413,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SD_Exported_macros SD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -615,10 +631,12 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported functions --------------------------------------------------------*/
/** @defgroup SD_Exported_Functions SD Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_Init (SD_HandleTypeDef *hsd);
@@ -631,6 +649,7 @@ void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Blocking mode: Polling */
@@ -673,6 +692,7 @@ HAL_StatusTypeDef HAL_SD_UnRegisterTransceiverCallback(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
@@ -682,6 +702,7 @@ HAL_StatusTypeDef HAL_SD_ConfigSpeedBusOperation(SD_HandleTypeDef *hsd, uint32_t */
/** @defgroup SD_Exported_Functions_Group4 SD card related functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_SD_CardStateTypeDef HAL_SD_GetCardState(SD_HandleTypeDef *hsd);
@@ -694,6 +715,7 @@ HAL_StatusTypeDef HAL_SD_GetCardInfo (SD_HandleTypeDef *hsd, HAL_SD_CardI */
/** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
@@ -703,6 +725,7 @@ uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_Abort (SD_HandleTypeDef *hsd);
@@ -713,6 +736,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private types -------------------------------------------------------------*/
/** @defgroup SD_Private_Types SD Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -722,6 +746,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private defines -----------------------------------------------------------*/
/** @defgroup SD_Private_Defines SD Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -731,6 +756,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private variables ---------------------------------------------------------*/
/** @defgroup SD_Private_Variables SD Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -740,6 +766,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private constants ---------------------------------------------------------*/
/** @defgroup SD_Private_Constants SD Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -749,6 +776,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private macros ------------------------------------------------------------*/
/** @defgroup SD_Private_Macros SD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -758,6 +786,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -767,6 +796,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private functions ---------------------------------------------------------*/
/** @defgroup SD_Private_Functions SD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd_ex.h index 4a5ff5ba8e..5c7cabfd56 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd_ex.h @@ -39,10 +39,12 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup SDEx_Exported_Types SDEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SDEx_Exported_Types_Group1 SD Card Internal DMA Buffer structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -64,10 +66,12 @@ typedef enum /* Exported macro ------------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup SDEx_Exported_Functions SDEx Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SDEx_Exported_Functions_Group1 MultiBuffer functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SDEx_ConfigDMAMultiBuffer(SD_HandleTypeDef *hsd, uint32_t * pDataBuffer0, uint32_t * pDataBuffer1, uint32_t BufferSize);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sdram.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sdram.h index 5bde520dc8..765559fb6e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sdram.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sdram.h @@ -40,6 +40,7 @@ extern "C" { /* Exported typedef ----------------------------------------------------------*/
/** @defgroup SDRAM_Exported_Types SDRAM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -112,6 +113,7 @@ typedef void (*pSDRAM_DmaCallbackTypeDef)(MDMA_HandleTypeDef *hmdma); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SDRAM_Exported_Macros SDRAM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard.h index 0fc2c6a70e..28568f9451 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -308,10 +309,12 @@ typedef enum /* Exported constants --------------------------------------------------------*/
/** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
@@ -336,6 +339,7 @@ typedef enum */
/** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SMARTCARD_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -353,6 +357,7 @@ typedef enum */
/** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */
@@ -361,6 +366,7 @@ typedef enum */
/** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */
@@ -370,6 +376,7 @@ typedef enum */
/** @defgroup SMARTCARD_Parity SMARTCARD Parity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */
@@ -379,6 +386,7 @@ typedef enum */
/** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */
@@ -389,6 +397,7 @@ typedef enum */
/** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */
@@ -398,6 +407,7 @@ typedef enum */
/** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */
@@ -407,6 +417,7 @@ typedef enum */
/** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */
@@ -416,6 +427,7 @@ typedef enum */
/** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */
@@ -425,6 +437,7 @@ typedef enum */
/** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */
@@ -434,6 +447,7 @@ typedef enum */
/** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */
@@ -443,6 +457,7 @@ typedef enum */
/** @defgroup SMARTCARD_ClockPrescaler SMARTCARD Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
@@ -462,6 +477,7 @@ typedef enum */
/** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
@@ -471,6 +487,7 @@ typedef enum */
/** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
@@ -480,6 +497,7 @@ typedef enum */
/** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
@@ -489,6 +507,7 @@ typedef enum */
/** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
@@ -498,6 +517,7 @@ typedef enum */
/** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
@@ -507,6 +527,7 @@ typedef enum */
/** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
@@ -516,6 +537,7 @@ typedef enum */
/** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
@@ -525,6 +547,7 @@ typedef enum */
/** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */
@@ -534,6 +557,7 @@ typedef enum */
/** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */
@@ -551,6 +575,7 @@ typedef enum /* Exported macros -----------------------------------------------------------*/
/** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -817,6 +842,7 @@ typedef enum /* Private macros -------------------------------------------------------------*/
/** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard_ex.h index 3b408ff52e..f18c60eaf8 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_smartcard_ex.h @@ -44,6 +44,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_Transmission_Completion_Indication SMARTCARD Transmission Completion Indication
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_TCBGT SMARTCARD_IT_TCBGT /*!< SMARTCARD transmission complete before guard time */
@@ -53,6 +54,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_Advanced_Features_Initialization_Type SMARTCARD advanced feature initialization type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
@@ -69,6 +71,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_FIFO_mode SMARTCARD FIFO mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD FIFO mode
* @{
*/
@@ -79,6 +82,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_TXFIFO_threshold_level SMARTCARD TXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD TXFIFO level
* @{
*/
@@ -93,6 +97,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_RXFIFO_threshold_level SMARTCARD RXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SMARTCARD RXFIFO level
* @{
*/
@@ -107,6 +112,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_Flags SMARTCARD Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the ISR register
* @{
@@ -136,6 +142,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_Interrupt_definition SMARTCARD Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 000ZZZZZ0XXYYYYYb
* - YYYYY : Interrupt source position in the XX register (5 bits)
* - XX : Interrupt source register (2 bits)
@@ -171,6 +178,7 @@ extern "C" { */
/** @defgroup SMARTCARDEx_IT_CLEAR_Flags SMARTCARD Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMARTCARD_CLEAR_PEF USART_ICR_PECF /*!< SMARTCARD parity error clear flag */
@@ -193,6 +201,7 @@ extern "C" { /* Exported macros -----------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup SMARTCARDEx_Private_Macros SMARTCARD Extended Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h index 283f66f974..cfb160cb1e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h @@ -38,10 +38,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
* @{
*/
@@ -205,10 +210,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)
@@ -218,6 +225,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_addressing_mode SMBUS addressing mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMBUS_ADDRESSINGMODE_7BIT (0x00000001U)
@@ -227,6 +235,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_dual_addressing_mode SMBUS dual addressing mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -237,6 +246,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_own_address2_masks SMBUS ownaddress2 masks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -254,6 +264,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)
@@ -263,6 +274,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_nostretch_mode SMBUS nostretch mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SMBUS_NOSTRETCH_DISABLE (0x00000000U)
@@ -272,6 +284,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)
@@ -281,6 +294,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
@@ -291,6 +305,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_ReloadEndMode_definition SMBUS ReloadEndMode definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -303,6 +318,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_StartStopMode_definition SMBUS StartStopMode definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -315,6 +331,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t */
/** @defgroup SMBUS_XferOptions_definition SMBUS XferOptions definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -341,6 +358,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
@@ -362,6 +380,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
@@ -394,6 +413,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t /* Exported macros ------------------------------------------------------------*/
/** @defgroup SMBUS_Exported_Macros SMBUS Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -530,6 +550,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t /* Private macros ------------------------------------------------------------*/
/** @defgroup SMBUS_Private_Macro SMBUS Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -714,6 +735,7 @@ uint32_t HAL_SMBUS_GetError(SMBUS_HandleTypeDef *hsmbus); /* Private Functions ---------------------------------------------------------*/
/** @defgroup SMBUS_Private_Functions SMBUS Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private functions are defined in stm32h7xx_hal_smbus.c file */
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h index 92bdf67fba..df6a7be5df 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_spdifrx.h @@ -40,6 +40,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_Types SPDIFRX Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -205,9 +206,11 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< /* Exported constants --------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_Constants SPDIFRX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPDIFRX_ErrorCode SPDIFRX Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SPDIFRX_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -224,6 +227,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Input_Selection SPDIFRX Input Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_INPUT_IN0 ((uint32_t)0x00000000U)
@@ -235,6 +239,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Max_Retries SPDIFRX Maximum Retries
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_MAXRETRIES_NONE ((uint32_t)0x00000000U)
@@ -246,6 +251,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Wait_For_Activity SPDIFRX Wait For Activity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_WAITFORACTIVITY_OFF ((uint32_t)0x00000000U)
@@ -255,6 +261,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_PT_Mask SPDIFRX Preamble Type Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_PREAMBLETYPEMASK_OFF ((uint32_t)0x00000000U)
@@ -264,6 +271,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_ChannelStatus_Mask SPDIFRX Channel Status Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_CHANNELSTATUS_OFF ((uint32_t)0x00000000U) /* The channel status and user bits are copied into the SPDIF_DR */
@@ -273,6 +281,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_V_Mask SPDIFRX Validity Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_VALIDITYMASK_OFF ((uint32_t)0x00000000U)
@@ -282,6 +291,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_PE_Mask SPDIFRX Parity Error Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_PARITYERRORMASK_OFF ((uint32_t)0x00000000U)
@@ -291,6 +301,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Channel_Selection SPDIFRX Channel Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_CHANNEL_A ((uint32_t)0x00000000U)
@@ -300,6 +311,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Data_Format SPDIFRX Data Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_DATAFORMAT_LSB ((uint32_t)0x00000000U)
@@ -310,6 +322,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Stereo_Mode SPDIFRX Stereo Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_STEREOMODE_DISABLE ((uint32_t)0x00000000U)
@@ -319,6 +332,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_State SPDIFRX State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -330,6 +344,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Interrupts_Definition SPDIFRX Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_IT_RXNE ((uint32_t)SPDIFRX_IMR_RXNEIE)
@@ -344,6 +359,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< */
/** @defgroup SPDIFRX_Flags_Definition SPDIFRX Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPDIFRX_FLAG_RXNE ((uint32_t)SPDIFRX_SR_RXNE)
@@ -365,6 +381,7 @@ typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef * hspdif); /*!< /* Exported macros -----------------------------------------------------------*/
/** @defgroup SPDIFRX_Exported_macros SPDIFRX Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -537,6 +554,7 @@ uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef const * const hspdif); /* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup SPDIFRX_Private_Macros SPDIFRX Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_SPDIFRX_INPUT_SELECT(INPUT) (((INPUT) == SPDIFRX_INPUT_IN1) || \
@@ -581,6 +599,7 @@ uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef const * const hspdif); /* Private functions ---------------------------------------------------------*/
/** @defgroup SPDIFRX_Private_Functions SPDIFRX Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_spi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_spi.h index 3b5dab5806..5be433919b 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_spi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_spi.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup SPI_Exported_Types SPI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -249,10 +250,12 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup SPI_Exported_Constants SPI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPI_FIFO_Type SPI FIFO Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_LOWEND_FIFO_SIZE 8UL
@@ -262,6 +265,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Error_Code SPI Error Codes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SPI_ERROR_NONE (0x00000000UL) /*!< No error */
@@ -284,6 +288,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Mode SPI Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_MODE_SLAVE (0x00000000UL)
@@ -293,6 +298,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Direction SPI Direction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_DIRECTION_2LINES (0x00000000UL)
@@ -304,6 +310,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Data_Size SPI Data Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_DATASIZE_4BIT (0x00000003UL)
@@ -340,6 +347,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Clock_Polarity SPI Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_POLARITY_LOW (0x00000000UL)
@@ -349,6 +357,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Clock_Phase SPI Clock Phase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_PHASE_1EDGE (0x00000000UL)
@@ -358,6 +367,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Slave_Select_Management SPI Slave Select Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_NSS_SOFT SPI_CFG2_SSM
@@ -368,6 +378,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_NSSP_Mode SPI NSS Pulse Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_NSS_PULSE_DISABLE (0x00000000UL)
@@ -377,6 +388,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_BaudRate_Prescaler SPI BaudRate Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_BAUDRATEPRESCALER_2 (0x00000000UL)
@@ -392,6 +404,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_MSB_LSB_Transmission SPI MSB LSB Transmission
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_FIRSTBIT_MSB (0x00000000UL)
@@ -401,6 +414,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_TI_Mode SPI TI Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_TIMODE_DISABLE (0x00000000UL)
@@ -410,6 +424,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_CRC_Calculation SPI CRC Calculation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_CRCCALCULATION_DISABLE (0x00000000UL)
@@ -419,6 +434,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_CRC_length SPI CRC Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_CRC_LENGTH_DATASIZE (0x00000000UL)
@@ -456,6 +472,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Fifo_Threshold SPI Fifo Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_FIFO_THRESHOLD_01DATA (0x00000000UL)
@@ -479,6 +496,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_CRC_Calculation_Initialization_Pattern SPI CRC Calculation Initialization Pattern
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_CRC_INITIALIZATION_ALL_ZERO_PATTERN (0x00000000UL)
@@ -488,6 +506,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_NSS_Polarity SPI NSS Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_NSS_POLARITY_LOW (0x00000000UL)
@@ -497,6 +516,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Master_Keep_IO_State Keep IO State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_MASTER_KEEP_IO_STATE_DISABLE (0x00000000UL)
@@ -506,6 +526,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_IO_Swap Control SPI IO Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_IO_SWAP_DISABLE (0x00000000UL)
@@ -515,6 +536,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Master_SS_Idleness SPI Master SS Idleness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_MASTER_SS_IDLENESS_00CYCLE (0x00000000UL)
@@ -538,6 +560,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Master_InterData_Idleness SPI Master Inter-Data Idleness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_MASTER_INTERDATA_IDLENESS_00CYCLE (0x00000000UL)
@@ -561,6 +584,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Master_RX_AutoSuspend SPI Master Receiver AutoSuspend
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_MASTER_RX_AUTOSUSP_DISABLE (0x00000000UL)
@@ -570,6 +594,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Underrun_Detection SPI Underrun Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_UNDERRUN_DETECT_BEGIN_DATA_FRAME (0x00000000UL)
@@ -580,6 +605,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Underrun_Behaviour SPI Underrun Behavior
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_UNDERRUN_BEHAV_REGISTER_PATTERN (0x00000000UL)
@@ -590,6 +616,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Interrupt_definition SPI Interrupt Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_IT_RXP SPI_IER_RXPIE
@@ -609,6 +636,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_Flags_definition SPI Flags Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_FLAG_RXP SPI_SR_RXP /* SPI status flag : Rx-Packet available flag */
@@ -631,6 +659,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to */
/** @defgroup SPI_reception_fifo_status_level SPI Reception FIFO Status Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SPI_RX_FIFO_0PACKET (0x00000000UL) /* 0 or multiple of 4 packets available in the RxFIFO */
@@ -647,6 +676,7 @@ typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to /* Exported macros -----------------------------------------------------------*/
/** @defgroup SPI_Exported_Macros SPI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -909,6 +939,7 @@ uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi); /* Private macros ------------------------------------------------------------*/
/** @defgroup SPI_Private_Macros SPI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sram.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sram.h index 33aaf83907..48dfa749a0 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sram.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sram.h @@ -39,6 +39,7 @@ extern "C" { /* Exported typedef ----------------------------------------------------------*/
/** @defgroup SRAM_Exported_Types SRAM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -109,6 +110,7 @@ typedef void (*pSRAM_DmaCallbackTypeDef)(MDMA_HandleTypeDef *hmdma); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SRAM_Exported_Macros SRAM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_swpmi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_swpmi.h index 0c34032988..f418efefd8 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_swpmi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_swpmi.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup SWPMI_Exported_Types SWPMI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -154,11 +155,13 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); /* Exported constants --------------------------------------------------------*/
/** @defgroup SWPMI_Exported_Constants SWPMI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
* @defgroup SWPMI_Error_Code SWPMI Error Code Bitmap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SWPMI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
@@ -177,6 +180,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); */
/** @defgroup SWPMI_Voltage_Class SWPMI Voltage Class
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SWPMI_VOLTAGE_CLASS_C ((uint32_t)0x00000000)
@@ -186,6 +190,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); */
/** @defgroup SWPMI_Tx_Buffering_Mode SWPMI Tx Buffering Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SWPMI_TX_NO_SOFTWAREBUFFER ((uint32_t)0x00000000)
@@ -196,6 +201,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); */
/** @defgroup SWPMI_Rx_Buffering_Mode SWPMI Rx Buffering Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SWPMI_RX_NO_SOFTWAREBUFFER ((uint32_t)0x00000000)
@@ -206,6 +212,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); */
/** @defgroup SWPMI_Flags SWPMI Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXXXXXX
* - 0xXXXXXXXX : Flag mask in the ISR register
* @{
@@ -227,6 +234,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); */
/** @defgroup SWPMI_Interrupt_definition SWPMI Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the IER register
* @{
@@ -251,6 +259,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); /* Exported macros -----------------------------------------------------------*/
/** @defgroup SWPMI_Exported_Macros SWPMI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -410,6 +419,7 @@ typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi); /* Exported functions --------------------------------------------------------*/
/** @defgroup SWPMI_Exported_Functions SWPMI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Initialization/de-initialization functions ********************************/
@@ -454,6 +464,7 @@ uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi); /* Private types -------------------------------------------------------------*/
/** @defgroup SWPMI_Private_Types SWPMI Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -463,6 +474,7 @@ uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi); /* Private variables ---------------------------------------------------------*/
/** @defgroup SWPMI_Private_Variables SWPMI Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -472,6 +484,7 @@ uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi); /* Private constants ---------------------------------------------------------*/
/** @defgroup SWPMI_Private_Constants SWPMI Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -481,6 +494,7 @@ uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi); /* Private macros ------------------------------------------------------------*/
/** @defgroup SWPMI_Private_Macros SWPMI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_tim.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_tim.h index 37a7ada848..cee271cd44 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_tim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_tim.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup TIM_Exported_Types TIM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -418,10 +419,12 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to /* Exported constants --------------------------------------------------------*/
/** @defgroup TIM_Exported_Constants TIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIM_ClearInput_Source TIM Clear Input Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLEARINPUTSOURCE_NONE 0x00000000U /*!< OCREF_CLR is disabled */
@@ -431,6 +434,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_DMA_Base_address TIM DMA Base Address
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_DMABASE_CR1 0x00000000U
@@ -466,6 +470,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Event_Source TIM Event Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_EVENTSOURCE_UPDATE TIM_EGR_UG /*!< Reinitialize the counter and generates an update of the registers */
@@ -482,6 +487,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Input_Channel_Polarity TIM Input Channel polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_INPUTCHANNELPOLARITY_RISING 0x00000000U /*!< Polarity for TIx source */
@@ -492,6 +498,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_ETR_Polarity TIM ETR Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ETRPOLARITY_INVERTED TIM_SMCR_ETP /*!< Polarity for ETR source */
@@ -501,6 +508,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_ETR_Prescaler TIM ETR Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ETRPRESCALER_DIV1 0x00000000U /*!< No prescaler is used */
@@ -512,6 +520,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Counter_Mode TIM Counter Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_COUNTERMODE_UP 0x00000000U /*!< Counter used as up-counter */
@@ -524,6 +533,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Update_Interrupt_Flag_Remap TIM Update Interrupt Flag Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_UIFREMAP_DISABLE 0x00000000U /*!< Update interrupt flag remap disabled */
@@ -533,6 +543,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_ClockDivision TIM Clock Division
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLOCKDIVISION_DIV1 0x00000000U /*!< Clock division: tDTS=tCK_INT */
@@ -543,6 +554,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_State TIM Output Compare State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OUTPUTSTATE_DISABLE 0x00000000U /*!< Capture/Compare 1 output disabled */
@@ -552,6 +564,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_AutoReloadPreload TIM Auto-Reload Preload
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_AUTORELOAD_PRELOAD_DISABLE 0x00000000U /*!< TIMx_ARR register is not buffered */
@@ -562,6 +575,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Fast_State TIM Output Fast State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCFAST_DISABLE 0x00000000U /*!< Output Compare fast disable */
@@ -571,6 +585,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_N_State TIM Complementary Output Compare State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OUTPUTNSTATE_DISABLE 0x00000000U /*!< OCxN is disabled */
@@ -580,6 +595,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_Polarity TIM Output Compare Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCPOLARITY_HIGH 0x00000000U /*!< Capture/Compare output polarity */
@@ -589,6 +605,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_N_Polarity TIM Complementary Output Compare Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCNPOLARITY_HIGH 0x00000000U /*!< Capture/Compare complementary output polarity */
@@ -598,6 +615,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_Idle_State TIM Output Compare Idle State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCIDLESTATE_SET TIM_CR2_OIS1 /*!< Output Idle state: OCx=1 when MOE=0 */
@@ -607,6 +625,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_N_Idle_State TIM Complementary Output Compare Idle State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCNIDLESTATE_SET TIM_CR2_OIS1N /*!< Complementary output Idle state: OCxN=1 when MOE=0 */
@@ -616,6 +635,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Input_Capture_Polarity TIM Input Capture Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ICPOLARITY_RISING TIM_INPUTCHANNELPOLARITY_RISING /*!< Capture triggered by rising edge on timer input */
@@ -626,6 +646,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Encoder_Input_Polarity TIM Encoder Input Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ENCODERINPUTPOLARITY_RISING TIM_INPUTCHANNELPOLARITY_RISING /*!< Encoder input with rising edge polarity */
@@ -635,6 +656,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Input_Capture_Selection TIM Input Capture Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ICSELECTION_DIRECTTI TIM_CCMR1_CC1S_0 /*!< TIM Input 1, 2, 3 or 4 is selected to be
@@ -647,6 +669,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Input_Capture_Prescaler TIM Input Capture Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ICPSC_DIV1 0x00000000U /*!< Capture performed each time an edge is detected on the capture input */
@@ -658,6 +681,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_One_Pulse_Mode TIM One Pulse Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OPMODE_SINGLE TIM_CR1_OPM /*!< Counter stops counting at the next update event */
@@ -667,6 +691,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Encoder_Mode TIM Encoder Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_ENCODERMODE_TI1 TIM_SMCR_SMS_0 /*!< Quadrature encoder mode 1, x2 mode, counts up/down on TI1FP1 edge depending on TI2FP2 level */
@@ -677,6 +702,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Interrupt_definition TIM interrupt Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_IT_UPDATE TIM_DIER_UIE /*!< Update interrupt */
@@ -692,6 +718,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Commutation_Source TIM Commutation Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_COMMUTATION_TRGI TIM_CR2_CCUS /*!< When Capture/compare control bits are preloaded, they are updated by setting the COMG bit or when an rising edge occurs on trigger input */
@@ -701,6 +728,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_DMA_sources TIM DMA Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_DMA_UPDATE TIM_DIER_UDE /*!< DMA request is triggered by the update event */
@@ -715,6 +743,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Flag_definition TIM Flag Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_FLAG_UPDATE TIM_SR_UIF /*!< Update interrupt flag */
@@ -738,6 +767,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Channel TIM Channel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CHANNEL_1 0x00000000U /*!< Capture/compare channel 1 identifier */
@@ -752,6 +782,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Clock_Source TIM Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLOCKSOURCE_ETRMODE2 TIM_SMCR_ETPS_1 /*!< External clock source mode 2 */
@@ -774,6 +805,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Clock_Polarity TIM Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLOCKPOLARITY_INVERTED TIM_ETRPOLARITY_INVERTED /*!< Polarity for ETRx clock sources */
@@ -786,6 +818,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Clock_Prescaler TIM Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLOCKPRESCALER_DIV1 TIM_ETRPRESCALER_DIV1 /*!< No prescaler is used */
@@ -797,6 +830,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_ClearInput_Polarity TIM Clear Input Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLEARINPUTPOLARITY_INVERTED TIM_ETRPOLARITY_INVERTED /*!< Polarity for ETRx pin */
@@ -806,6 +840,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_ClearInput_Prescaler TIM Clear Input Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CLEARINPUTPRESCALER_DIV1 TIM_ETRPRESCALER_DIV1 /*!< No prescaler is used */
@@ -817,6 +852,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_OSSR_Off_State_Selection_for_Run_mode_state TIM OSSR OffState Selection for Run mode state
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OSSR_ENABLE TIM_BDTR_OSSR /*!< When inactive, OC/OCN outputs are enabled (still controlled by the timer) */
@@ -826,6 +862,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_OSSI_Off_State_Selection_for_Idle_mode_state TIM OSSI OffState Selection for Idle mode state
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OSSI_ENABLE TIM_BDTR_OSSI /*!< When inactive, OC/OCN outputs are enabled (still controlled by the timer) */
@@ -834,6 +871,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to * @}
*/
/** @defgroup TIM_Lock_level TIM Lock level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_LOCKLEVEL_OFF 0x00000000U /*!< LOCK OFF */
@@ -845,6 +883,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Break_Input_enable_disable TIM Break Input Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAK_ENABLE TIM_BDTR_BKE /*!< Break input BRK is enabled */
@@ -854,6 +893,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Break_Polarity TIM Break Input Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAKPOLARITY_LOW 0x00000000U /*!< Break input BRK is active low */
@@ -863,6 +903,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Break2_Input_enable_disable TIM Break input 2 Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAK2_DISABLE 0x00000000U /*!< Break input BRK2 is disabled */
@@ -872,6 +913,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Break2_Polarity TIM Break Input 2 Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAK2POLARITY_LOW 0x00000000U /*!< Break input BRK2 is active low */
@@ -881,6 +923,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_AOE_Bit_Set_Reset TIM Automatic Output Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_AUTOMATICOUTPUT_DISABLE 0x00000000U /*!< MOE can be set only by software */
@@ -891,6 +934,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Group_Channel5 Group Channel 5 and Channel 1, 2 or 3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_GROUPCH5_NONE 0x00000000U /* !< No effect of OC5REF on OC1REFC, OC2REFC and OC3REFC */
@@ -902,6 +946,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Master_Mode_Selection TIM Master Mode Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TRGO_RESET 0x00000000U /*!< TIMx_EGR.UG bit is used as trigger output (TRGO) */
@@ -917,6 +962,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Master_Mode_Selection_2 TIM Master Mode Selection 2 (TRGO2)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TRGO2_RESET 0x00000000U /*!< TIMx_EGR.UG bit is used as trigger output (TRGO2) */
@@ -940,6 +986,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Master_Slave_Mode TIM Master/Slave Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_MASTERSLAVEMODE_ENABLE TIM_SMCR_MSM /*!< No action */
@@ -949,6 +996,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Slave_Mode TIM Slave mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_SLAVEMODE_DISABLE 0x00000000U /*!< Slave mode disabled */
@@ -962,6 +1010,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Output_Compare_and_PWM_modes TIM Output Compare and PWM Modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_OCMODE_TIMING 0x00000000U /*!< Frozen */
@@ -983,6 +1032,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Trigger_Selection TIM Trigger Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TS_ITR0 0x00000000U /*!< Internal Trigger 0 (ITR0) */
@@ -1009,6 +1059,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Trigger_Polarity TIM Trigger Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TRIGGERPOLARITY_INVERTED TIM_ETRPOLARITY_INVERTED /*!< Polarity for ETRx trigger sources */
@@ -1021,6 +1072,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Trigger_Prescaler TIM Trigger Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TRIGGERPRESCALER_DIV1 TIM_ETRPRESCALER_DIV1 /*!< No prescaler is used */
@@ -1032,6 +1084,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_TI1_Selection TIM TI1 Input Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TI1SELECTION_CH1 0x00000000U /*!< The TIMx_CH1 pin is connected to TI1 input */
@@ -1041,6 +1094,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_DMA_Burst_Length TIM DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_DMABURSTLENGTH_1TRANSFER 0x00000000U /*!< The transfer is done to 1 register starting trom TIMx_CR1 + TIMx_DCR.DBA */
@@ -1066,6 +1120,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup DMA_Handle_index TIM DMA Handle Index
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_DMA_ID_UPDATE ((uint16_t) 0x0000) /*!< Index of the DMA handle used for Update DMA requests */
@@ -1080,6 +1135,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup Channel_CC_State TIM Capture/Compare Channel State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_CCx_ENABLE 0x00000001U /*!< Input or output channel is enabled */
@@ -1091,6 +1147,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to */
/** @defgroup TIM_Break_System TIM Break System
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAK_SYSTEM_ECC SYSCFG_CFGR2_ECCL /*!< Enables and locks the ECC error signal with Break Input of TIM1/8/15/16/17 */
@@ -1108,6 +1165,7 @@ typedef void (*pTIM_CallbackTypeDef)(TIM_HandleTypeDef *htim); /*!< pointer to /* Exported macros -----------------------------------------------------------*/
/** @defgroup TIM_Exported_Macros TIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1671,6 +1729,7 @@ mode. /* Private constants ---------------------------------------------------------*/
/** @defgroup TIM_Private_Constants TIM Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* The counter of a timer instance is disabled only if all the CCx and CCxN
@@ -1684,6 +1743,7 @@ mode. /* Private macros ------------------------------------------------------------*/
/** @defgroup TIM_Private_Macros TIM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_TIM_CLEARINPUT_SOURCE(__MODE__) (((__MODE__) == TIM_CLEARINPUTSOURCE_NONE) || \
@@ -2162,6 +2222,7 @@ void HAL_TIM_IRQHandler(TIM_HandleTypeDef *htim); */
/** @defgroup TIM_Exported_Functions_Group8 TIM Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions
* @{
*/
@@ -2196,6 +2257,7 @@ uint32_t HAL_TIM_ReadCapturedValue(TIM_HandleTypeDef *htim, uint32_t Channel); */
/** @defgroup TIM_Exported_Functions_Group9 TIM Callbacks functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief TIM Callbacks functions
* @{
*/
@@ -2223,6 +2285,7 @@ HAL_StatusTypeDef HAL_TIM_UnRegisterCallback(TIM_HandleTypeDef *htim, HAL_TIM_Ca */
/** @defgroup TIM_Exported_Functions_Group10 TIM Peripheral State functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State functions
* @{
*/
@@ -2244,6 +2307,7 @@ HAL_TIM_StateTypeDef HAL_TIM_Encoder_GetState(TIM_HandleTypeDef *htim); /* Private functions----------------------------------------------------------*/
/** @defgroup TIM_Private_Functions TIM Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void TIM_Base_SetConfig(TIM_TypeDef *TIMx, TIM_Base_InitTypeDef *Structure);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_tim_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_tim_ex.h index 0a7ef48a78..6ae52bc265 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_tim_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_tim_ex.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup TIMEx_Exported_Types TIM Extended Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -84,10 +85,12 @@ TIMEx_BreakInputConfigTypeDef; /* Exported constants --------------------------------------------------------*/
/** @defgroup TIMEx_Exported_Constants TIM Extended Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIMEx_Remap TIM Extended Remapping
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TIM1_ETR_GPIO 0x00000000U /* !< TIM1_ETR is connected to GPIO */
@@ -141,6 +144,7 @@ TIMEx_BreakInputConfigTypeDef; #if defined(TIM_BREAK_INPUT_SUPPORT)
/** @defgroup TIMEx_Break_Input TIM Extended Break input
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAKINPUT_BRK 0x00000001U /* !< Timer break input */
@@ -150,6 +154,7 @@ TIMEx_BreakInputConfigTypeDef; */
/** @defgroup TIMEx_Break_Input_Source TIM Extended Break input source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAKINPUTSOURCE_BKIN 0x00000001U /* !< An external source (GPIO) is connected to the BKIN pin */
@@ -161,6 +166,7 @@ TIMEx_BreakInputConfigTypeDef; */
/** @defgroup TIMEx_Break_Input_Source_Enable TIM Extended Break input source enabling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAKINPUTSOURCE_DISABLE 0x00000000U /* !< Break input source is disabled */
@@ -170,6 +176,7 @@ TIMEx_BreakInputConfigTypeDef; */
/** @defgroup TIMEx_Break_Input_Source_Polarity TIM Extended Break input polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_BREAKINPUTSOURCE_POLARITY_LOW 0x00000001U /* !< Break input source is active low */
@@ -180,6 +187,7 @@ TIMEx_BreakInputConfigTypeDef; #endif /* TIM_BREAK_INPUT_SUPPORT */
/** @defgroup TIMEx_Timer_Input_Selection TIM Extended Timer input selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define TIM_TIM1_TI1_GPIO 0x00000000U /* !< TIM1_TI1 is connected to GPIO */
@@ -248,6 +256,7 @@ TIMEx_BreakInputConfigTypeDef; /* Exported macro ------------------------------------------------------------*/
/** @defgroup TIMEx_Exported_Macros TIM Extended Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -258,6 +267,7 @@ TIMEx_BreakInputConfigTypeDef; /* Private macro -------------------------------------------------------------*/
/** @defgroup TIMEx_Private_Macros TIM Extended Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_TIM_BREAKINPUT(__BREAKINPUT__) (((__BREAKINPUT__) == TIM_BREAKINPUT_BRK) || \
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h index 48eb8db373..e9fecc4aa0 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup UART_Exported_Types UART Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -296,10 +297,12 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer /* Exported constants --------------------------------------------------------*/
/** @defgroup UART_Exported_Constants UART Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UART_State_Definition UART State Code Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
@@ -324,6 +327,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Error_Definition UART Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_UART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -342,6 +346,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Stop_Bits UART Number of Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */
@@ -353,6 +358,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Parity UART Parity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_PARITY_NONE 0x00000000U /*!< No parity */
@@ -363,6 +369,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */
@@ -374,6 +381,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Mode UART Transfer Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_MODE_RX USART_CR1_RE /*!< RX mode */
@@ -384,6 +392,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_State UART State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */
@@ -393,6 +402,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Over_Sampling UART Over Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
@@ -402,6 +412,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */
@@ -411,6 +422,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_ClockPrescaler UART Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
@@ -430,6 +442,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection on start bit */
@@ -441,6 +454,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Receiver_Timeout UART Receiver Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART Receiver Timeout disable */
@@ -450,6 +464,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_LIN UART Local Interconnection Network mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */
@@ -459,6 +474,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_LIN_Break_Detection UART LIN Break Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */
@@ -468,6 +484,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_DMA_Tx UART DMA Tx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */
@@ -477,6 +494,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_DMA_Rx UART DMA Rx
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */
@@ -486,6 +504,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */
@@ -495,6 +514,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_WakeUp_Methods UART WakeUp Methods
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */
@@ -504,6 +524,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Request_Parameters UART Request Parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
@@ -516,6 +537,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
@@ -532,6 +554,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
@@ -541,6 +564,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
@@ -550,6 +574,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
@@ -559,6 +584,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
@@ -568,6 +594,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
@@ -577,6 +604,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */
@@ -586,6 +614,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
@@ -595,6 +624,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_MSB_First UART Advanced Feature MSB First
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
@@ -604,6 +634,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Stop_Mode_Enable UART Advanced Feature Stop Mode Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U /*!< UART stop mode disable */
@@ -613,6 +644,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */
@@ -622,6 +654,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */
@@ -630,6 +663,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_WakeUp_from_Stop_Selection UART WakeUp From Stop Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_WAKEUP_ON_ADDRESS 0x00000000U /*!< UART wake-up on address */
@@ -640,6 +674,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */
@@ -649,6 +684,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB position in CR1 register */
@@ -657,6 +693,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB position in CR1 register */
@@ -665,6 +702,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */
@@ -673,6 +711,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_TimeOut_Value UART polling-based communications time-out value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */
@@ -681,6 +720,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Flags UART Status Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the ISR register
* @{
@@ -717,6 +757,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_Interrupt_definition UART Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 000ZZZZZ0XXYYYYYb
* - YYYYY : Interrupt source position in the XX register (5bits)
* - XX : Interrupt source register (2bits)
@@ -761,6 +802,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer */
/** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
@@ -786,6 +828,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer /* Exported macros -----------------------------------------------------------*/
/** @defgroup UART_Exported_Macros UART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1150,6 +1193,7 @@ typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer /* Private macros --------------------------------------------------------*/
/** @defgroup UART_Private_Macros UART Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Get UART clok division factor from clock prescaler value.
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart_ex.h index bad4a66762..b7bb3107d5 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_uart_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_uart_ex.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup UARTEx_Exported_Types UARTEx Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -63,10 +64,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UARTEx_Word_Length UARTEx Word Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long UART frame */
@@ -77,6 +80,7 @@ typedef struct */
/** @defgroup UARTEx_WakeUp_Address_Length UARTEx WakeUp Address Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define UART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit long wake-up address */
@@ -86,6 +90,7 @@ typedef struct */
/** @defgroup UARTEx_FIFO_mode UARTEx FIFO mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART FIFO mode
* @{
*/
@@ -96,6 +101,7 @@ typedef struct */
/** @defgroup UARTEx_TXFIFO_threshold_level UARTEx TXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART TXFIFO threshold level
* @{
*/
@@ -110,6 +116,7 @@ typedef struct */
/** @defgroup UARTEx_RXFIFO_threshold_level UARTEx RXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief UART RXFIFO threshold level
* @{
*/
@@ -184,6 +191,7 @@ HAL_StatusTypeDef HAL_UARTEx_SetRxFifoThreshold(UART_HandleTypeDef *huart, uint3 /* Private macros ------------------------------------------------------------*/
/** @defgroup UARTEx_Private_Macros UARTEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h index 2a5682a0f2..9ab2db8356 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart.h @@ -38,6 +38,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup USART_Exported_Types USART Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -212,10 +213,12 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin /* Exported constants --------------------------------------------------------*/
/** @defgroup USART_Exported_Constants USART Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USART_Error_Definition USART Error Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_USART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -234,6 +237,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Stop_Bits USART Number of Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
@@ -245,6 +249,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Parity USART Parity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_PARITY_NONE 0x00000000U /*!< No parity */
@@ -255,6 +260,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Mode USART Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_MODE_RX USART_CR1_RE /*!< RX mode */
@@ -265,6 +271,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Over_Sampling USART Over Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
@@ -274,6 +281,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Clock USART Clock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_CLOCK_DISABLE 0x00000000U /*!< USART clock disable */
@@ -283,6 +291,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Clock_Polarity USART Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_POLARITY_LOW 0x00000000U /*!< Driver enable signal is active high */
@@ -292,6 +301,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Clock_Phase USART Clock Phase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_PHASE_1EDGE 0x00000000U /*!< USART frame phase on first clock transition */
@@ -301,6 +311,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Last_Bit USART Last Bit
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_LASTBIT_DISABLE 0x00000000U /*!< USART frame last data bit clock pulse not output to SCLK pin */
@@ -310,6 +321,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_ClockPrescaler USART Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
@@ -330,6 +342,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Request_Parameters USART Request Parameters
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
@@ -339,6 +352,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Flags USART Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0xXXXX
* - 0xXXXX : Flag mask in the ISR register
* @{
@@ -367,6 +381,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Interrupt_definition USART Interrupts Definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * Elements values convention: 0000ZZZZ0XXYYYYYb
* - YYYYY : Interrupt source position in the XX register (5bits)
* - XX : Interrupt source register (2bits)
@@ -398,6 +413,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
@@ -414,6 +430,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin */
/** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_IT_MASK 0x001FU /*!< USART interruptions flags mask */
@@ -431,6 +448,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin /* Exported macros -----------------------------------------------------------*/
/** @defgroup USART_Exported_Macros USART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -685,6 +703,7 @@ typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< poin /* Private macros --------------------------------------------------------*/
/** @defgroup USART_Private_Macros USART Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart_ex.h index 2fa4390af8..9d45e9e373 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_usart_ex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_usart_ex.h @@ -39,10 +39,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USARTEx_Word_Length USARTEx Word Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long USART frame */
@@ -53,6 +55,7 @@ extern "C" { */
/** @defgroup USARTEx_Slave_Select_management USARTEx Slave Select Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USART_NSS_HARD 0x00000000U /*!< SPI slave selection depends on NSS input pin */
@@ -63,6 +66,7 @@ extern "C" { /** @defgroup USARTEx_Slave_Mode USARTEx Synchronous Slave mode enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART SLAVE mode
* @{
*/
@@ -73,6 +77,7 @@ extern "C" { */
/** @defgroup USARTEx_FIFO_mode USARTEx FIFO mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART FIFO mode
* @{
*/
@@ -83,6 +88,7 @@ extern "C" { */
/** @defgroup USARTEx_TXFIFO_threshold_level USARTEx TXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART TXFIFO level
* @{
*/
@@ -97,6 +103,7 @@ extern "C" { */
/** @defgroup USARTEx_RXFIFO_threshold_level USARTEx RXFIFO threshold level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief USART RXFIFO level
* @{
*/
@@ -116,6 +123,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup USARTEx_Private_Macros USARTEx Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_wwdg.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_wwdg.h index 32e6379208..19edfb3a83 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_wwdg.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_wwdg.h @@ -39,6 +39,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/** @defgroup WWDG_Exported_Types WWDG Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -104,10 +105,12 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t /* Exported constants --------------------------------------------------------*/
/** @defgroup WWDG_Exported_Constants WWDG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup WWDG_Interrupt_definition WWDG Interrupt definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define WWDG_IT_EWI WWDG_CFR_EWI /*!< Early wakeup interrupt */
@@ -116,6 +119,7 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t */
/** @defgroup WWDG_Flag_definition WWDG Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief WWDG Flag definition
* @{
*/
@@ -125,6 +129,7 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t */
/** @defgroup WWDG_Prescaler WWDG Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define WWDG_PRESCALER_1 0x00000000u /*!< WWDG counter clock = (PCLK1/4096)/1 */
@@ -140,6 +145,7 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t */
/** @defgroup WWDG_EWI_Mode WWDG Early Wakeup Interrupt Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define WWDG_EWI_DISABLE 0x00000000u /*!< EWI Disable */
@@ -155,6 +161,7 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t /* Private macros ------------------------------------------------------------*/
/** @defgroup WWDG_Private_Macros WWDG Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \
@@ -180,6 +187,7 @@ typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp); /*!< pointer t /* Exported macros ------------------------------------------------------------*/
/** @defgroup WWDG_Exported_Macros WWDG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_adc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_adc.h index 918bb50929..64d1c0588c 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_adc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_adc.h @@ -35,6 +35,7 @@ extern "C" { #if defined (ADC1) || defined (ADC2) || defined (ADC3)
/** @defgroup ADC_LL ADC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup ADC_LL_Private_Constants ADC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -386,6 +388,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup ADC_LL_Private_Macros ADC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -408,6 +411,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup ADC_LL_ES_INIT ADC Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -601,10 +605,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup ADC_LL_Exported_Constants ADC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_LL_EC_FLAG ADC flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_ADC_ReadReg function
* @{
*/
@@ -646,6 +652,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_IT ADC interruptions for configuration (interruption enable or disable)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_ADC_ReadReg and LL_ADC_WriteReg functions
* @{
*/
@@ -665,6 +672,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REGISTERS ADC registers compliant with specific purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* List of ADC registers intended to be used (most commonly) with */
@@ -677,6 +685,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_COMMON_CLOCK_SOURCE ADC common - Clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_CLOCK_SYNC_PCLK_DIV1 (ADC_CCR_CKMODE_0) /*!< ADC synchronous clock derived from AHB clock without prescaler */
@@ -699,6 +708,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_COMMON_PATH_INTERNAL ADC common - Measurement path to internal channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Note: Other measurement paths to internal channels may be available */
@@ -715,6 +725,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_BOOST_MODE ADC instance - Boost mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_BOOST_MODE_6MHZ25 (0x00000000UL) /*!< Boost mode is configured for frequency <= 6.25Mhz */
@@ -727,6 +738,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_CALIBRATION_OFFSET_LINEARITY ADC instance - Calibration mode for offset and linearity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_CALIB_OFFSET (ADC_CALIB_FACTOR_OFFSET_REGOFFSET) /*!< Calibration of ADC offset. Duration of calibration of offset duration: 1280 ADC clock cycles. For devices with differential mode available: Calibration of offset is specific to each of single-ended and differential modes. */
@@ -737,6 +749,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_CALIBRATION_LINEARITY_WORD ADC instance - Calibration linearity words
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_CALIB_LINEARITY_WORD1 (ADC_CR_LINCALRDYW1) /*!< ADC calibration linearity word 1 */
@@ -750,6 +763,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_RESOLUTION ADC instance - Resolution
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_RESOLUTION_16B (0x00000000UL) /*!< ADC resolution 16 bits */
@@ -766,6 +780,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_LEFT_BIT_SHIFT ADC left Shift
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_LEFT_BIT_SHIFT_NONE (0x00000000UL) /*!< ADC no bit shift left applied on the final ADC convesion data */
@@ -789,6 +804,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_LP_MODE ADC instance - Low power mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_LP_MODE_NONE (0x00000000UL) /*!< No ADC low power mode activated */
@@ -798,6 +814,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OFFSET_NB ADC instance - Offset number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OFFSET_1 ADC_OFR1_REGOFFSET /*!< ADC offset number 1: ADC channel and offset level to which the offset programmed will be applied (independently of channel mapped on ADC group regular or group injected) */
@@ -809,6 +826,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OFFSET_SIGNED_SATURATION ADC instance - Offset signed saturation mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OFFSET_SIGNED_SATURATION_DISABLE (0x00000000UL) /*!< ADC offset signed saturation is disabled (among ADC selected offset number 1, 2, 3 or 4) */
@@ -818,6 +836,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OFFSET_RSHIFT ADC instance - Offset right shift
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OFFSET_RSHIFT_DISABLE (0x00000000UL) /*!< ADC offset right shift is disabled (among ADC selected offset number 1, 2, 3 or 4) */
@@ -826,6 +845,7 @@ typedef struct * @}
*/
/** @defgroup ADC_LL_EC_GROUPS ADC instance - Groups
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_GROUP_REGULAR (0x00000001UL) /*!< ADC group regular (available on all STM32 devices) */
@@ -836,6 +856,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_CHANNEL ADC instance - Channel number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_CHANNEL_0 (ADC_CHANNEL_0_NUMBER | ADC_CHANNEL_0_SMP | ADC_CHANNEL_0_BITFIELD ) /*!< ADC external channel (channel connected to GPIO pin) ADCx_IN0 */
@@ -880,6 +901,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_TRIGGER_SOURCE ADC group regular - Trigger source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_TRIG_SOFTWARE (0x00000000UL) /*!< ADC group regular conversion trigger internal: SW start. */
@@ -909,6 +931,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_TRIGGER_EDGE ADC group regular - Trigger edge
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_TRIG_EXT_RISING ( ADC_CFGR_EXTEN_0) /*!< ADC group regular conversion trigger polarity set to rising edge */
@@ -919,6 +942,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_CONTINUOUS_MODE ADC group regular - Continuous mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_CONV_SINGLE (0x00000000UL) /*!< ADC conversions are performed in single mode: one conversion per trigger */
@@ -928,6 +952,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_DATA_TRANSFER_MODE ADC group regular - Data transfer mode of ADC conversion data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_DR_TRANSFER (0x00000000UL) /*!< ADC conversions are transferred to DR rigister */
@@ -939,6 +964,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_OVR_DATA_BEHAVIOR ADC group regular - Overrun behavior on conversion data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_OVR_DATA_PRESERVED (0x00000000UL) /*!< ADC group regular behavior in case of overrun: data preserved */
@@ -948,6 +974,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_SEQ_SCAN_LENGTH ADC group regular - Sequencer scan length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_SEQ_SCAN_DISABLE (0x00000000UL) /*!< ADC group regular sequencer disable (equivalent to sequencer of 1 rank: ADC conversion on only 1 channel) */
@@ -971,6 +998,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_SEQ_DISCONT_MODE ADC group regular - Sequencer discontinuous mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_SEQ_DISCONT_DISABLE (0x00000000UL) /*!< ADC group regular sequencer discontinuous mode disable */
@@ -987,6 +1015,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_REG_SEQ_RANKS ADC group regular - Sequencer ranks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_REG_RANK_1 (ADC_SQR1_REGOFFSET | ADC_REG_RANK_1_SQRX_BITOFFSET_POS) /*!< ADC group regular sequencer rank 1 */
@@ -1010,6 +1039,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_TRIGGER_SOURCE ADC group injected - Trigger source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_TRIG_SOFTWARE (0x00000000UL) /*!< ADC group injected conversion trigger internal: SW start. */
@@ -1039,6 +1069,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_TRIGGER_EDGE ADC group injected - Trigger edge
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_TRIG_EXT_RISING ( ADC_JSQR_JEXTEN_0) /*!< ADC group injected conversion trigger polarity set to rising edge */
@@ -1049,6 +1080,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_TRIG_AUTO ADC group injected - Automatic trigger mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_TRIG_INDEPENDENT (0x00000000UL) /*!< ADC group injected conversion trigger independent. Setting mandatory if ADC group injected injected trigger source is set to an external trigger. */
@@ -1058,6 +1090,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_CONTEXT_QUEUE ADC group injected - Context queue mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_QUEUE_2CONTEXTS_LAST_ACTIVE (0x00000000UL) /* Group injected sequence context queue is enabled and can contain up to 2 contexts. When all contexts have been processed, the queue maintains the last context active perpetually. */
@@ -1068,6 +1101,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_SEQ_SCAN_LENGTH ADC group injected - Sequencer scan length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_SEQ_SCAN_DISABLE (0x00000000UL) /*!< ADC group injected sequencer disable (equivalent to sequencer of 1 rank: ADC conversion on only 1 channel) */
@@ -1079,6 +1113,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_SEQ_DISCONT_MODE ADC group injected - Sequencer discontinuous mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_SEQ_DISCONT_DISABLE (0x00000000UL) /*!< ADC group injected sequencer discontinuous mode disable */
@@ -1088,6 +1123,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_INJ_SEQ_RANKS ADC group injected - Sequencer ranks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_INJ_RANK_1 (ADC_JDR1_REGOFFSET | ADC_INJ_RANK_1_JSQR_BITOFFSET_POS) /*!< ADC group injected sequencer rank 1 */
@@ -1099,6 +1135,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_CHANNEL_SAMPLINGTIME Channel - Sampling time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_SAMPLINGTIME_1CYCLE_5 (0x00000000UL) /*!< Sampling time 1.5 ADC clock cycles */
@@ -1114,6 +1151,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_CHANNEL_SINGLE_DIFF_ENDING Channel - Single or differential ending
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_SINGLE_ENDED ( ADC_CALFACT_CALFACT_S) /*!< ADC channel ending set to single ended (literal also used to set calibration mode) */
@@ -1124,6 +1162,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_AWD_NUMBER Analog watchdog - Analog watchdog number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_AWD1 (ADC_AWD_CR1_CHANNEL_MASK | ADC_AWD_CR1_REGOFFSET) /*!< ADC analog watchdog number 1 */
@@ -1134,6 +1173,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_AWD_CHANNELS Analog watchdog - Monitored channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_AWD_DISABLE (0x00000000UL) /*!< ADC analog watchdog monitoring disabled */
@@ -1220,6 +1260,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_AWD_THRESHOLDS Analog watchdog - Thresholds
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_AWD_THRESHOLD_HIGH (0x1UL) /*!< ADC analog watchdog threshold high */
@@ -1229,6 +1270,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OVS_SCOPE Oversampling - Oversampling scope
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OVS_DISABLE (0x00000000UL) /*!< ADC oversampling disabled. */
@@ -1241,6 +1283,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OVS_DISCONT_MODE Oversampling - Discontinuous mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OVS_REG_CONT (0x00000000UL) /*!< ADC oversampling discontinuous mode: continuous mode (all conversions of oversampling ratio are done from 1 trigger) */
@@ -1250,6 +1293,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_OVS_SHIFT Oversampling - Data shift
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_OVS_SHIFT_NONE (0x00000000UL) /*!< ADC oversampling no shift (sum of the ADC conversions data is not divided to result as the ADC oversampling conversion data) */
@@ -1269,6 +1313,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_MULTI_MODE Multimode - Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_MULTI_INDEPENDENT (0x00000000UL) /*!< ADC dual mode disabled (ADC independent mode) */
@@ -1284,6 +1329,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_MULTI_DMA_TRANSFER Multimode - DMA transfer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_MULTI_REG_DMA_EACH_ADC (0x00000000UL) /*!< ADC multimode group regular conversions are transferred by DMA: each ADC uses its own DMA channel, with its individual DMA transfer settings */
@@ -1294,6 +1340,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_MULTI_TWOSMP_DELAY Multimode - Delay between two sampling phases
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_MULTI_TWOSMP_DELAY_1CYCLE_5 (0x00000000UL) /*!< ADC multimode delay between two sampling phases: 1.5 ADC clock cycle for all resolution */
@@ -1314,6 +1361,7 @@ typedef struct */
/** @defgroup ADC_LL_EC_MULTI_MASTER_SLAVE Multimode - ADC master or slave
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_ADC_MULTI_MASTER ( ADC_CDR_RDATA_MST) /*!< In multimode, selection among several ADC instances: ADC master */
@@ -1326,6 +1374,7 @@ typedef struct /** @defgroup ADC_LL_EC_HW_DELAYS Definitions of ADC hardware constraints delays
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note Only ADC peripheral HW delays are defined in ADC LL driver driver,
* not timeout values.
* For details on delays values, refer to descriptions in source code
@@ -1399,10 +1448,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup ADC_LL_Exported_Macros ADC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_LL_EM_WRITE_READ Common write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1427,6 +1478,7 @@ typedef struct */
/** @defgroup ADC_LL_EM_HELPER_MACRO ADC helper macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2255,10 +2307,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup ADC_LL_Exported_Functions ADC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup ADC_LL_EF_DMA_Management ADC DMA management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2315,6 +2369,7 @@ __STATIC_INLINE uint32_t LL_ADC_DMA_GetRegAddr(ADC_TypeDef *ADCx, uint32_t Regis */
/** @defgroup ADC_LL_EF_Configuration_ADC_Common Configuration of ADC hierarchical scope: common to several ADC instances
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2452,6 +2507,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetCommonPathInternalCh(ADC_Common_TypeDef *ADCx */
/** @defgroup ADC_LL_EF_Configuration_ADC_Instance Configuration of ADC hierarchical scope: ADC instance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3030,6 +3086,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetOffsetSignedSaturation(ADC_TypeDef *ADCx, uin */
/** @defgroup ADC_LL_EF_Configuration_ADC_Group_Regular Configuration of ADC hierarchical scope: group regular
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3682,6 +3739,7 @@ __STATIC_INLINE uint32_t LL_ADC_REG_GetOverrun(ADC_TypeDef *ADCx) */
/** @defgroup ADC_LL_EF_Configuration_ADC_Group_Injected Configuration of ADC hierarchical scope: group injected
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4403,6 +4461,7 @@ __STATIC_INLINE void LL_ADC_INJ_ConfigQueueContext(ADC_TypeDef *ADCx, */
/** @defgroup ADC_LL_EF_Configuration_Channels Configuration of ADC hierarchical scope: channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4703,6 +4762,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetChannelSingleDiff(ADC_TypeDef *ADCx, uint32_t */
/** @defgroup ADC_LL_EF_Configuration_ADC_AnalogWatchdog Configuration of ADC transversal scope: analog watchdog
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5137,6 +5197,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetAnalogWDThresholds(ADC_TypeDef *ADCx, uint32_ */
/** @defgroup ADC_LL_EF_Configuration_ADC_oversampling Configuration of ADC transversal scope: oversampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5316,6 +5377,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetOverSamplingShift(ADC_TypeDef *ADCx) */
/** @defgroup ADC_LL_EF_Configuration_ADC_Multimode Configuration of ADC hierarchical scope: multimode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -5596,6 +5658,7 @@ __STATIC_INLINE uint32_t LL_ADC_GetMultiTwoSamplingDelay(ADC_Common_TypeDef *ADC * @}
*/
/** @defgroup ADC_LL_EF_Operation_ADC_Instance Operation on ADC hierarchical scope: ADC instance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5833,6 +5896,7 @@ __STATIC_INLINE uint32_t LL_ADC_IsCalibrationOnGoing(ADC_TypeDef *ADCx) */
/** @defgroup ADC_LL_EF_Operation_ADC_Group_Regular Operation on ADC hierarchical scope: group regular
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6028,6 +6092,7 @@ __STATIC_INLINE uint32_t LL_ADC_REG_ReadMultiConversionData32(ADC_Common_TypeDef */
/** @defgroup ADC_LL_EF_Operation_ADC_Group_Injected Operation on ADC hierarchical scope: group injected
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6267,6 +6332,7 @@ __STATIC_INLINE uint8_t LL_ADC_INJ_ReadConversionData8(ADC_TypeDef *ADCx, uint32 */
/** @defgroup ADC_LL_EF_FLAG_Management ADC flag management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6787,6 +6853,7 @@ __STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_SLV_AWD3(ADC_Common_TypeDef *ADCxy_ */
/** @defgroup ADC_LL_EF_IT_Management ADC IT management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -7170,6 +7237,7 @@ __STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_AWD3(ADC_TypeDef *ADCx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup ADC_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_bdma.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_bdma.h index 7117788da6..b38886e266 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_bdma.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_bdma.h @@ -36,12 +36,14 @@ extern "C" { #if defined (BDMA) || defined (BDMA1) || defined (BDMA2)
/** @defgroup BDMA_LL BDMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup BDMA_LL_Private_Variables BDMA Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Array used to get the BDMA channel register offset versus channel index LL_BDMA_CHANNEL_x */
@@ -69,6 +71,7 @@ static const uint8_t LL_BDMA_CH_OFFSET_TAB[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup BDMA_LL_ES_INIT BDMA Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -145,9 +148,11 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup BDMA_LL_Exported_Constants BDMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup BDMA_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_BDMA_WriteReg function
* @{
*/
@@ -184,6 +189,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_BDMA_ReadReg function
* @{
*/
@@ -224,6 +230,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_BDMA_ReadReg and LL_BDMA_WriteReg functions
* @{
*/
@@ -235,6 +242,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_CHANNEL CHANNEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_CHANNEL_0 0x00000000U /*!< DMA Channel 0 */
@@ -253,6 +261,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_DIRECTION Transfer Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_DIRECTION_PERIPH_TO_MEMORY 0x00000000U /*!< Peripheral to memory direction */
@@ -263,6 +272,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_MODE Transfer mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_MODE_NORMAL 0x00000000U /*!< Normal Mode */
@@ -272,6 +282,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_DOUBLEBUFFER_MODE DOUBLE BUFFER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_DOUBLEBUFFER_MODE_DISABLE 0x00000000U /*!< Disable double buffering mode */
@@ -281,6 +292,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_PERIPH Peripheral increment mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_PERIPH_INCREMENT BDMA_CCR_PINC /*!< Peripheral increment mode Enable */
@@ -290,6 +302,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_MEMORY Memory increment mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_MEMORY_INCREMENT BDMA_CCR_MINC /*!< Memory increment mode Enable */
@@ -299,6 +312,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_PDATAALIGN Peripheral data alignment
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_PDATAALIGN_BYTE 0x00000000U /*!< Peripheral data alignment : Byte */
@@ -309,6 +323,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_MDATAALIGN Memory data alignment
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_MDATAALIGN_BYTE 0x00000000U /*!< Memory data alignment : Byte */
@@ -319,6 +334,7 @@ typedef struct */
/** @defgroup BDMA_LL_EC_PRIORITY Transfer Priority level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_PRIORITY_LOW 0x00000000U /*!< Priority level : Low */
@@ -330,6 +346,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_CURRENTTARGETMEM CURRENTTARGETMEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_BDMA_CURRENTTARGETMEM0 0x00000000U /*!< Set CurrentTarget Memory to Memory 0 */
@@ -340,10 +357,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup BDMA_LL_Exported_Macros BDMA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup BDMA_LL_EM_WRITE_READ Common Write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -367,6 +386,7 @@ typedef struct */
/** @defgroup BDMA_LL_EM_CONVERT_DMAxCHANNELy Convert BDMAxChannely
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -461,10 +481,12 @@ LL_BDMA_CHANNEL_7) /* Exported functions --------------------------------------------------------*/
/** @defgroup BDMA_LL_Exported_Functions BDMA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup BDMA_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1460,6 +1482,7 @@ __STATIC_INLINE uint32_t LL_BDMA_GetPeriphRequest(BDMA_TypeDef *BDMAx, uint32_t /** @defgroup BDMA_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -2170,6 +2193,7 @@ __STATIC_INLINE void LL_BDMA_ClearFlag_TE7(BDMA_TypeDef *BDMAx) */
/** @defgroup BDMA_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -2376,6 +2400,7 @@ __STATIC_INLINE uint32_t LL_BDMA_IsEnabledIT_TE(BDMA_TypeDef *BDMAx, uint32_t Ch #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup BDMA_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_bus.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_bus.h index 6ee1528aab..5a83e49236 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_bus.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_bus.h @@ -54,6 +54,7 @@ extern "C" { #if defined(RCC)
/** @defgroup BUS_LL BUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -67,10 +68,12 @@ extern "C" { /* Exported constants --------------------------------------------------------*/
/** @defgroup BUS_LL_Exported_Constants BUS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup BUS_LL_EC_AHB3_GRP1_PERIPH AHB3 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_AHB3_GRP1_PERIPH_MDMA RCC_AHB3ENR_MDMAEN
@@ -121,6 +124,7 @@ extern "C" { /** @defgroup BUS_LL_EC_AHB1_GRP1_PERIPH AHB1 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_AHB1_GRP1_PERIPH_DMA1 RCC_AHB1ENR_DMA1EN
@@ -149,6 +153,7 @@ extern "C" { /** @defgroup BUS_LL_EC_AHB2_GRP1_PERIPH AHB2 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_AHB2_GRP1_PERIPH_DCMI RCC_AHB2ENR_DCMIEN
@@ -187,6 +192,7 @@ extern "C" { /** @defgroup BUS_LL_EC_AHB4_GRP1_PERIPH AHB4 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_AHB4_GRP1_PERIPH_GPIOA RCC_AHB4ENR_GPIOAEN
@@ -230,6 +236,7 @@ extern "C" { /** @defgroup BUS_LL_EC_APB3_GRP1_PERIPH APB3 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_APB3_GRP1_PERIPH_LTDC RCC_APB3ENR_LTDCEN
@@ -246,6 +253,7 @@ extern "C" { /** @defgroup BUS_LL_EC_APB1_GRP1_PERIPH APB1 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_APB1_GRP1_PERIPH_TIM2 RCC_APB1LENR_TIM2EN
@@ -281,6 +289,7 @@ extern "C" { /** @defgroup BUS_LL_EC_APB1_GRP2_PERIPH APB1 GRP2 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_APB1_GRP2_PERIPH_CRS RCC_APB1HENR_CRSEN
@@ -294,6 +303,7 @@ extern "C" { /** @defgroup BUS_LL_EC_APB2_GRP1_PERIPH APB2 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_APB2_GRP1_PERIPH_TIM1 RCC_APB2ENR_TIM1EN
@@ -327,6 +337,7 @@ extern "C" { /** @defgroup BUS_LL_EC_APB4_GRP1_PERIPH APB4 GRP1 PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_APB4_GRP1_PERIPH_SYSCFG RCC_APB4ENR_SYSCFGEN
@@ -361,6 +372,7 @@ extern "C" { */
/** @defgroup BUS_LL_EC_CLKAM_PERIPH CLKAM PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3AMR_BDMAAMEN)
@@ -453,6 +465,7 @@ extern "C" { #if defined(RCC_CKGAENR_AXICKG)
/** @defgroup BUS_LL_EC_CKGA_PERIPH CKGA (AXI Clocks Gating) PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CKGA_PERIPH_AXI RCC_CKGAENR_AXICKG
@@ -486,10 +499,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup BUS_LL_Exported_Functions BUS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup BUS_LL_EF_AHB3 AHB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -806,6 +821,7 @@ __STATIC_INLINE void LL_AHB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB1 AHB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1055,6 +1071,7 @@ __STATIC_INLINE void LL_AHB1_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB2 AHB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1278,6 +1295,7 @@ __STATIC_INLINE void LL_AHB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB4 AHB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1600,6 +1618,7 @@ __STATIC_INLINE void LL_AHB4_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB3 APB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1738,6 +1757,7 @@ __STATIC_INLINE void LL_APB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB1 APB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2328,6 +2348,7 @@ __STATIC_INLINE void LL_APB1_GRP2_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB2 APB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2662,6 +2683,7 @@ __STATIC_INLINE void LL_APB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB4 APB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2968,6 +2990,7 @@ __STATIC_INLINE void LL_APB4_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_CLKAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3133,6 +3156,7 @@ __STATIC_INLINE void LL_CKGA_Disable(uint32_t Periphs) #if defined(DUAL_CORE)
/** @defgroup BUS_LL_EF_AHB3 AHB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3347,6 +3371,7 @@ __STATIC_INLINE void LL_C1_AHB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB1 AHB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3543,6 +3568,7 @@ __STATIC_INLINE void LL_C1_AHB1_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB2 AHB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3715,6 +3741,7 @@ __STATIC_INLINE void LL_C1_AHB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB4 AHB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3953,6 +3980,7 @@ __STATIC_INLINE void LL_C1_AHB4_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB3 APB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4059,6 +4087,7 @@ __STATIC_INLINE void LL_C1_APB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB1 APB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4493,6 +4522,7 @@ __STATIC_INLINE void LL_C1_APB1_GRP2_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB2 APB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4736,6 +4766,7 @@ __STATIC_INLINE void LL_C1_APB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB4 APB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4953,6 +4984,7 @@ __STATIC_INLINE void LL_C1_APB4_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB3 AHB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5127,6 +5159,7 @@ __STATIC_INLINE void LL_C2_AHB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB1 AHB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5303,6 +5336,7 @@ __STATIC_INLINE void LL_C2_AHB1_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB2 AHB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5441,6 +5475,7 @@ __STATIC_INLINE void LL_C2_AHB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_AHB4 AHB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5679,6 +5714,7 @@ __STATIC_INLINE void LL_C2_AHB4_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB3 APB3
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5785,6 +5821,7 @@ __STATIC_INLINE void LL_C2_APB3_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB1 APB1
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6209,6 +6246,7 @@ __STATIC_INLINE void LL_C2_APB1_GRP2_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB2 APB2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6425,6 +6463,7 @@ __STATIC_INLINE void LL_C2_APB2_GRP1_DisableClockSleep(uint32_t Periphs) */
/** @defgroup BUS_LL_EF_APB4 APB4
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_comp.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_comp.h index d71be0ed88..894078319a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_comp.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_comp.h @@ -35,6 +35,7 @@ extern "C" { #if defined (COMP1) || defined (COMP2)
/** @defgroup COMP_LL COMP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -42,6 +43,7 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup COMP_LL_Private_Constants COMP Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -56,6 +58,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup COMP_LL_ES_INIT COMP Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -103,10 +106,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup COMP_LL_Exported_Constants COMP Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_LL_EC_COMMON_WINDOWMODE Comparator common modes - Window mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_WINDOWMODE_DISABLE (0x00000000UL) /*!< Window mode disable: Comparators 1 and 2 are independent */
@@ -116,6 +121,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_POWERMODE Comparator modes - Power mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_POWERMODE_HIGHSPEED (0x00000000UL) /*!< COMP power mode to high speed */
@@ -126,6 +132,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_INPUT_PLUS Comparator inputs - Input plus (input non-inverting) selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_INPUT_PLUS_IO1 (0x00000000UL) /*!< Comparator input plus connected to IO1 (pin PB0 for COMP1, pin PE9 for COMP2) */
@@ -138,6 +145,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_INPUT_MINUS Comparator inputs - Input minus (input inverting) selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_INPUT_MINUS_1_4VREFINT ( COMP_CFGRx_SCALEN | COMP_CFGRx_BRGEN) /*!< Comparator input minus connected to 1/4 VrefInt */
@@ -157,6 +165,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_INPUT_HYSTERESIS Comparator input - Hysteresis
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_HYSTERESIS_NONE (0x00000000UL) /*!< No hysteresis */
@@ -168,6 +177,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_OUTPUT_POLARITY Comparator output - Output polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_OUTPUTPOL_NONINVERTED (0x00000000UL) /*!< COMP output polarity is not inverted: comparator output is high when the plus (non-inverting) input is at a higher voltage than the minus (inverting) input */
@@ -177,6 +187,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_OUTPUT_BLANKING_SOURCE Comparator output - Blanking source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_BLANKINGSRC_NONE (0x00000000UL) /*!<Comparator output without blanking */
@@ -191,6 +202,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_OUTPUT_LEVEL Comparator output - Output level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_OUTPUT_LEVEL_LOW (0x00000000UL) /*!< Comparator output level low (if the polarity is not inverted, otherwise to be complemented) */
@@ -199,6 +211,7 @@ typedef struct * @}
*/
/** @defgroup COMP_LL_EC_OUTPUT_BKIN_TIMER Comparator output - Output to BKIN timer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_COMP_AF_PA6 COMP_OR_AFOPA6 /*!< Comparator Alternate Function PA6 source selected to timer BKIN input */
@@ -217,6 +230,7 @@ typedef struct */
/** @defgroup COMP_LL_EC_HW_DELAYS Definitions of COMP hardware constraints delays
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note Only COMP IP HW delays are defined in COMP LL driver driver,
* not timeout values.
* For details on delays values, refer to descriptions in source code
@@ -249,9 +263,11 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup COMP_LL_Exported_Macros COMP Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_LL_EM_WRITE_READ Common write and read registers macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -276,6 +292,7 @@ typedef struct */
/** @defgroup COMP_LL_EM_HELPER_MACRO COMP helper macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -301,10 +318,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup COMP_LL_Exported_Functions COMP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup COMP_LL_EF_Configuration_comparator_common Configuration of COMP hierarchical scope: common to several COMP instances
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -346,6 +365,7 @@ __STATIC_INLINE uint32_t LL_COMP_GetCommonWindowMode(COMP_Common_TypeDef *COMPxy */
/** @defgroup COMP_LL_EF_Configuration_comparator_modes Configuration of comparator modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -383,6 +403,7 @@ __STATIC_INLINE uint32_t LL_COMP_GetPowerMode(COMP_TypeDef *COMPx) */
/** @defgroup COMP_LL_EF_Configuration_comparator_inputs Configuration of comparator inputs
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -597,6 +618,7 @@ __STATIC_INLINE uint32_t LL_COMP_GetInputHysteresis(COMP_TypeDef *COMPx) */
/** @defgroup COMP_LL_EF_Configuration_comparator_output Configuration of comparator output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -723,6 +745,7 @@ __STATIC_INLINE uint32_t LL_COMP_GetOutputAlternateFunction(COMP_TypeDef *COMPx */
/** @defgroup COMP_LL_EF_Operation Operation on comparator instance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -828,6 +851,7 @@ __STATIC_INLINE uint32_t LL_COMP_ReadOutputLevel(COMP_TypeDef *COMPx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup COMP_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_cortex.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_cortex.h index c7363b9c4a..41e0a33da3 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_cortex.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_cortex.h @@ -48,6 +48,7 @@ extern "C" { */
/** @defgroup CORTEX_LL CORTEX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -61,10 +62,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup CORTEX_LL_Exported_Constants CORTEX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CORTEX_LL_EC_CLKSOURCE_HCLK SYSTICK Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSTICK_CLKSOURCE_HCLK_DIV8 0x00000000UL /*!< AHB clock divided by 8 selected as SysTick clock source.*/
@@ -74,6 +77,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_FAULT Handler Fault type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_HANDLER_FAULT_USG SCB_SHCSR_USGFAULTENA_Msk /*!< Usage fault */
@@ -86,6 +90,7 @@ extern "C" { #if __MPU_PRESENT
/** @defgroup CORTEX_LL_EC_CTRL_HFNMI_PRIVDEF MPU Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_CTRL_HFNMI_PRIVDEF_NONE 0x00000000UL /*!< Disable NMI and privileged SW access */
@@ -97,6 +102,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_REGION MPU Region Number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_REGION_NUMBER0 0x00UL /*!< REGION Number 0 */
@@ -122,6 +128,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_REGION_SIZE MPU Region Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_REGION_SIZE_32B (0x04UL << MPU_RASR_SIZE_Pos) /*!< 32B Size of the MPU protection region */
@@ -157,6 +164,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_REGION_PRIVILEDGES MPU Region Privileges
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_REGION_NO_ACCESS (0x00UL << MPU_RASR_AP_Pos) /*!< No access*/
@@ -170,6 +178,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_TEX MPU TEX Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_TEX_LEVEL0 (0x00UL << MPU_RASR_TEX_Pos) /*!< b000 for TEX bits */
@@ -181,6 +190,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_INSTRUCTION_ACCESS MPU Instruction Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_INSTRUCTION_ACCESS_ENABLE 0x00UL /*!< Instruction fetches enabled */
@@ -190,6 +200,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_SHAREABLE_ACCESS MPU Shareable Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_ACCESS_SHAREABLE MPU_RASR_S_Msk /*!< Shareable memory attribute */
@@ -199,6 +210,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_CACHEABLE_ACCESS MPU Cacheable Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_ACCESS_CACHEABLE MPU_RASR_C_Msk /*!< Cacheable memory attribute */
@@ -208,6 +220,7 @@ extern "C" { */
/** @defgroup CORTEX_LL_EC_BUFFERABLE_ACCESS MPU Bufferable Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MPU_ACCESS_BUFFERABLE MPU_RASR_B_Msk /*!< Bufferable memory attribute */
@@ -224,10 +237,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup CORTEX_LL_Exported_Functions CORTEX Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CORTEX_LL_EF_SYSTICK SYSTICK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -302,6 +317,7 @@ __STATIC_INLINE uint32_t LL_SYSTICK_IsEnabledIT(void) */
/** @defgroup CORTEX_LL_EF_LOW_POWER_MODE LOW POWER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -380,6 +396,7 @@ __STATIC_INLINE void LL_LPM_DisableEventOnPend(void) */
/** @defgroup CORTEX_LL_EF_HANDLER HANDLER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -418,6 +435,7 @@ __STATIC_INLINE void LL_HANDLER_DisableFault(uint32_t Fault) */
/** @defgroup CORTEX_LL_EF_MCU_INFO MCU INFO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -477,6 +495,7 @@ __STATIC_INLINE uint32_t LL_CPUID_GetRevision(void) #if __MPU_PRESENT
/** @defgroup CORTEX_LL_EF_MPU MPU
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_crc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_crc.h index 23e50299f7..56b1a27c9b 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_crc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_crc.h @@ -35,6 +35,7 @@ extern "C" { #if defined(CRC)
/** @defgroup CRC_LL CRC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -46,10 +47,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup CRC_LL_Exported_Constants CRC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_LL_EC_POLYLENGTH Polynomial length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRC_POLYLENGTH_32B 0x00000000U /*!< 32 bits Polynomial size */
@@ -61,6 +64,7 @@ extern "C" { */
/** @defgroup CRC_LL_EC_INDATA_REVERSE Input Data Reverse
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRC_INDATA_REVERSE_NONE 0x00000000U /*!< Input Data bit order not affected */
@@ -72,6 +76,7 @@ extern "C" { */
/** @defgroup CRC_LL_EC_OUTDATA_REVERSE Output Data Reverse
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRC_OUTDATA_REVERSE_NONE 0x00000000U /*!< Output Data bit order not affected */
@@ -81,6 +86,7 @@ extern "C" { */
/** @defgroup CRC_LL_EC_Default_Polynomial_Value Default CRC generating polynomial value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Normal representation of this polynomial value is
* X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2 + X + 1 .
* @{
@@ -91,6 +97,7 @@ extern "C" { */
/** @defgroup CRC_LL_EC_Default_InitValue Default CRC computation initialization value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRC_DEFAULT_CRC_INITVALUE 0xFFFFFFFFU /*!< Default CRC computation initialization value */
@@ -104,10 +111,12 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup CRC_LL_Exported_Macros CRC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -138,10 +147,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup CRC_LL_Exported_Functions CRC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRC_LL_EF_Configuration CRC Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -312,6 +323,7 @@ __STATIC_INLINE uint32_t LL_CRC_GetPolynomialCoef(CRC_TypeDef *CRCx) */
/** @defgroup CRC_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -431,6 +443,7 @@ __STATIC_INLINE void LL_CRC_Write_IDR(CRC_TypeDef *CRCx, uint32_t InData) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup CRC_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_crs.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_crs.h index ded313beb9..ec0c01f25d 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_crs.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_crs.h @@ -35,6 +35,7 @@ extern "C" { #if defined(CRS)
/** @defgroup CRS_LL CRS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -46,10 +47,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup CRS_LL_Exported_Constants CRS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRS_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_CRS_ReadReg function
* @{
*/
@@ -65,6 +68,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_CRS_ReadReg and LL_CRS_WriteReg functions
* @{
*/
@@ -77,6 +81,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_SYNC_DIV Synchronization Signal Divider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRS_SYNC_DIV_1 0x00000000U /*!< Synchro Signal not divided (default) */
@@ -92,6 +97,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_SYNC_SOURCE Synchronization Signal Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRS_SYNC_SOURCE_GPIO 0x00000000U /*!< Synchro Signal soucre GPIO */
@@ -102,6 +108,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_SYNC_POLARITY Synchronization Signal Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRS_SYNC_POLARITY_RISING 0x00000000U /*!< Synchro Active on rising edge (default) */
@@ -111,6 +118,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_FREQERRORDIR Frequency Error Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_CRS_FREQ_ERROR_DIR_UP 0x00000000U /*!< Upcounting direction, the actual frequency is above the target */
@@ -120,6 +128,7 @@ extern "C" { */
/** @defgroup CRS_LL_EC_DEFAULTVALUES Default Values
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -151,10 +160,12 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup CRS_LL_Exported_Macros CRS Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRS_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -179,6 +190,7 @@ extern "C" { */
/** @defgroup CRS_LL_EM_Exported_Macros_Calculate_Reload Exported_Macros_Calculate_Reload
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -205,10 +217,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup CRS_LL_Exported_Functions CRS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup CRS_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -461,6 +475,7 @@ __STATIC_INLINE void LL_CRS_ConfigSynchronization(uint32_t HSI48CalibrationValue */
/** @defgroup CRS_LL_EF_CRS_Management CRS_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -502,6 +517,7 @@ __STATIC_INLINE uint32_t LL_CRS_GetFreqErrorCapture(void) */
/** @defgroup CRS_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -621,6 +637,7 @@ __STATIC_INLINE void LL_CRS_ClearFlag_ESYNC(void) */
/** @defgroup CRS_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -750,6 +767,7 @@ __STATIC_INLINE uint32_t LL_CRS_IsEnabledIT_ESYNC(void) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup CRS_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_dac.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_dac.h index bf3155c33c..a04b96e3f4 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_dac.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_dac.h @@ -35,6 +35,7 @@ extern "C" { #if defined(DAC1) || defined(DAC2)
/** @defgroup DAC_LL DAC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup DAC_LL_Private_Constants DAC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -105,6 +107,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup DAC_LL_Private_Macros DAC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -127,6 +130,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DAC_LL_ES_INIT DAC Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -176,10 +180,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup DAC_LL_Exported_Constants DAC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DAC_LL_EC_GET_FLAG DAC flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_DAC_ReadReg function
* @{
*/
@@ -197,6 +203,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_IT DAC interruptions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_DAC_ReadReg and LL_DAC_WriteReg functions
* @{
*/
@@ -207,6 +214,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_CHANNEL DAC channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_CHANNEL_1 (DAC_REG_SHSR1_REGOFFSET | DAC_REG_DOR1_REGOFFSET | DAC_REG_DHR12R1_REGOFFSET | DAC_REG_DHR12L1_REGOFFSET | DAC_REG_DHR8R1_REGOFFSET | DAC_CR_CH1_BITOFFSET | DAC_SWTR_CH1) /*!< DAC channel 1 */
@@ -216,6 +224,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_OPERATING_MODE DAC operating mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_MODE_NORMAL_OPERATION 0x00000000UL /*!< DAC channel in mode normal operation */
@@ -225,6 +234,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_TRIGGER_SOURCE DAC trigger source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_TRIG_SOFTWARE 0x00000000U /*!< DAC channel conversion trigger internal (SW start) */
@@ -257,6 +267,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_WAVE_AUTO_GENERATION_MODE DAC waveform automatic generation mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_WAVE_AUTO_GENERATION_NONE 0x00000000UL /*!< DAC channel wave auto generation mode disabled. */
@@ -267,6 +278,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_WAVE_NOISE_LFSR_UNMASK_BITS DAC wave generation - Noise LFSR unmask bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_NOISE_LFSR_UNMASK_BIT0 0x00000000UL /*!< Noise wave generation, unmask LFSR bit0, for the selected DAC channel */
@@ -286,6 +298,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_WAVE_TRIANGLE_AMPLITUDE DAC wave generation - Triangle amplitude
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_TRIANGLE_AMPLITUDE_1 0x00000000UL /*!< Triangle wave generation, amplitude of 1 LSB of DAC output range, for the selected DAC channel */
@@ -305,6 +318,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_OUTPUT_MODE DAC channel output mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_OUTPUT_MODE_NORMAL 0x00000000UL /*!< The selected DAC channel output is on mode normal. */
@@ -314,6 +328,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_OUTPUT_BUFFER DAC channel output buffer
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_OUTPUT_BUFFER_ENABLE 0x00000000UL /*!< The selected DAC channel output is buffered: higher drive current capability, but also higher current consumption */
@@ -323,6 +338,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_OUTPUT_CONNECTION DAC channel output connection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_OUTPUT_CONNECT_GPIO 0x00000000UL /*!< The selected DAC channel output is connected to external pin */
@@ -332,6 +348,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_LEGACY DAC literals legacy naming
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_TRIGGER_SOFTWARE (LL_DAC_TRIG_SOFTWARE)
@@ -352,6 +369,7 @@ typedef struct * @}
*/
/** @defgroup DAC_LL_EC_RESOLUTION DAC channel output resolution
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DAC_RESOLUTION_12B 0x00000000UL /*!< DAC channel resolution 12 bits */
@@ -361,6 +379,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_REGISTERS DAC registers compliant with specific purpose
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* List of DAC registers intended to be used (most commonly) with */
@@ -374,6 +393,7 @@ typedef struct */
/** @defgroup DAC_LL_EC_HW_DELAYS Definitions of DAC hardware constraints delays
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note Only DAC peripheral HW delays are defined in DAC LL driver driver,
* not timeout values.
* For details on delays values, refer to descriptions in source code
@@ -418,10 +438,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup DAC_LL_Exported_Macros DAC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DAC_LL_EM_WRITE_READ Common write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -447,6 +469,7 @@ typedef struct */
/** @defgroup DAC_LL_EM_HELPER_MACRO DAC helper macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -546,9 +569,11 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup DAC_LL_Exported_Functions DAC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DAC_LL_EF_Configuration Configuration of DAC channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1225,6 +1250,7 @@ __STATIC_INLINE uint32_t LL_DAC_GetSampleAndHoldRefreshTime(DAC_TypeDef *DACx, u */
/** @defgroup DAC_LL_EF_DMA_Management DMA Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1325,6 +1351,7 @@ __STATIC_INLINE uint32_t LL_DAC_DMA_GetRegAddr(DAC_TypeDef *DACx, uint32_t DAC_C */
/** @defgroup DAC_LL_EF_Operation Operation on DAC channels
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1620,6 +1647,7 @@ __STATIC_INLINE uint32_t LL_DAC_RetrieveOutputData(DAC_TypeDef *DACx, uint32_t D */
/** @defgroup DAC_LL_EF_FLAG_Management FLAG Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1723,6 +1751,7 @@ __STATIC_INLINE void LL_DAC_ClearFlag_DMAUDR2(DAC_TypeDef *DACx) */
/** @defgroup DAC_LL_EF_IT_Management IT management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1804,6 +1833,7 @@ __STATIC_INLINE uint32_t LL_DAC_IsEnabledIT_DMAUDR2(DAC_TypeDef *DACx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DAC_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_delayblock.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_delayblock.h index 315151d4cb..cfc7547796 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_delayblock.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_delayblock.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup DELAYBLOCK_LL_Exported_Types DELAYBLOCK_LL Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -48,6 +49,7 @@ /* Exported constants --------------------------------------------------------*/
/** @defgroup DLYB_Exported_Constants Delay Block Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_dma.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_dma.h index f5553b69e5..da48506801 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_dma.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_dma.h @@ -36,12 +36,14 @@ extern "C" { #if defined (DMA1) || defined (DMA2)
/** @defgroup DMA_LL DMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup DMA_LL_Private_Variables DMA Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Array used to get the DMA stream register offset versus stream index LL_DMA_STREAM_x */
@@ -77,6 +79,7 @@ static const uint8_t LL_DMA_STR_OFFSET_TAB[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DMA_LL_ES_INIT DMA Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -180,10 +183,12 @@ typedef struct #endif /*USE_FULL_LL_DRIVER*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup DMA_LL_Exported_Constants DMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA_LL_EC_STREAM STREAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_STREAM_0 0x00000000U
@@ -201,6 +206,7 @@ typedef struct /** @defgroup DMA_LL_EC_DIRECTION DIRECTION
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_DIRECTION_PERIPH_TO_MEMORY 0x00000000U /*!< Peripheral to memory direction */
@@ -211,6 +217,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_MODE MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_MODE_NORMAL 0x00000000U /*!< Normal Mode */
@@ -221,6 +228,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_DOUBLEBUFFER_MODE DOUBLE BUFFER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_DOUBLEBUFFER_MODE_DISABLE 0x00000000U /*!< Disable double buffering mode */
@@ -230,6 +238,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_PERIPH PERIPH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_PERIPH_NOINCREMENT 0x00000000U /*!< Peripheral increment mode Disable */
@@ -239,6 +248,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_MEMORY MEMORY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_MEMORY_NOINCREMENT 0x00000000U /*!< Memory increment mode Disable */
@@ -248,6 +258,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_PDATAALIGN PDATAALIGN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_PDATAALIGN_BYTE 0x00000000U /*!< Peripheral data alignment : Byte */
@@ -258,6 +269,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_MDATAALIGN MDATAALIGN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_MDATAALIGN_BYTE 0x00000000U /*!< Memory data alignment : Byte */
@@ -268,6 +280,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_OFFSETSIZE OFFSETSIZE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_OFFSETSIZE_PSIZE 0x00000000U /*!< Peripheral increment offset size is linked to the PSIZE */
@@ -277,6 +290,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_PRIORITY PRIORITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_PRIORITY_LOW 0x00000000U /*!< Priority level : Low */
@@ -289,6 +303,7 @@ typedef struct /** @defgroup DMA_LL_EC_MBURST MBURST
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_MBURST_SINGLE 0x00000000U /*!< Memory burst single transfer configuration */
@@ -300,6 +315,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_PBURST PBURST
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_PBURST_SINGLE 0x00000000U /*!< Peripheral burst single transfer configuration */
@@ -311,6 +327,7 @@ typedef struct */
/** @defgroup DMA_LL_FIFOMODE DMA_LL_FIFOMODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_FIFOMODE_DISABLE 0x00000000U /*!< FIFO mode disable (direct mode is enabled) */
@@ -320,6 +337,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_FIFOSTATUS_0 FIFOSTATUS 0
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_FIFOSTATUS_0_25 0x00000000U /*!< 0 < fifo_level < 1/4 */
@@ -333,6 +351,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_FIFOTHRESHOLD FIFOTHRESHOLD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_FIFOTHRESHOLD_1_4 0x00000000U /*!< FIFO threshold 1 quart full configuration */
@@ -344,6 +363,7 @@ typedef struct */
/** @defgroup DMA_LL_EC_CURRENTTARGETMEM CURRENTTARGETMEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA_CURRENTTARGETMEM0 0x00000000U /*!< Set CurrentTarget Memory to Memory 0 */
@@ -358,10 +378,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup DMA_LL_Exported_Macros DMA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA_LL_EM_WRITE_READ Common Write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -385,6 +407,7 @@ typedef struct */
/** @defgroup DMA_LL_EM_CONVERT_DMAxCHANNELy Convert DMAxStreamy
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -452,10 +475,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup DMA_LL_Exported_Functions DMA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1984,6 +2009,7 @@ __STATIC_INLINE uint32_t LL_DMA_GetMemory1Address(DMA_TypeDef *DMAx, uint32_t St */
/** @defgroup DMA_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2872,6 +2898,7 @@ __STATIC_INLINE void LL_DMA_ClearFlag_FE7(DMA_TypeDef *DMAx) */
/** @defgroup DMA_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3211,6 +3238,7 @@ __STATIC_INLINE uint32_t LL_DMA_IsEnabledIT_FE(DMA_TypeDef *DMAx, uint32_t Strea #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DMA_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_dma2d.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_dma2d.h index 957aee52eb..bbe23554d1 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_dma2d.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_dma2d.h @@ -35,6 +35,7 @@ extern "C" { #if defined (DMA2D)
/** @defgroup DMA2D_LL DMA2D
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -44,6 +45,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DMA2D_LL_Private_Macros DMA2D Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -55,6 +57,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DMA2D_LL_ES_Init_Struct DMA2D Exported Init structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -317,10 +320,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup DMA2D_LL_Exported_Constants DMA2D Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_DMA2D_ReadReg function
* @{
*/
@@ -335,6 +340,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_DMA2D_ReadReg and LL_DMA2D_WriteReg functions
* @{
*/
@@ -349,6 +355,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_MODE Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_MODE_M2M 0x00000000U /*!< DMA2D memory to memory transfer mode */
@@ -362,6 +369,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_OUTPUT_COLOR_MODE Output Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_OUTPUT_MODE_ARGB8888 0x00000000U /*!< ARGB8888 */
@@ -374,6 +382,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_INPUT_COLOR_MODE Input Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_INPUT_MODE_ARGB8888 0x00000000U /*!< ARGB8888 */
@@ -393,6 +402,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_ALPHA_MODE Alpha Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_ALPHA_MODE_NO_MODIF 0x00000000U /*!< No modification of the alpha channel value */
@@ -404,6 +414,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_OUTPUT_SWAP_MODE Swap Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_SWAP_MODE_REGULAR 0x00000000U /*!< Regular order */
@@ -413,6 +424,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_RED_BLUE_SWAP Red Blue Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_RB_MODE_REGULAR 0x00000000U /*!< RGB or ARGB */
@@ -422,6 +434,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_ALPHA_INVERSION Alpha Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_ALPHA_REGULAR 0x00000000U /*!< Regular alpha */
@@ -432,6 +445,7 @@ typedef struct /** @defgroup DMA2D_LL_EC_LINE_OFFSET_MODE Line Offset Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_LINE_OFFSET_PIXELS 0x00000000U /*!< Line offsets are expressed in pixels */
@@ -441,6 +455,7 @@ typedef struct */
/** @defgroup DMA2D_LL_EC_CLUT_COLOR_MODE CLUT Color Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_CLUT_COLOR_MODE_ARGB8888 0x00000000U /*!< ARGB8888 */
@@ -450,6 +465,7 @@ typedef struct */
/** @defgroup DMA2D_LL_CHROMA_SUB_SAMPLING Chroma Sub Sampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMA2D_CSS_444 0x00000000U /*!< No chroma sub-sampling 4:4:4 */
@@ -465,10 +481,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup DMA2D_LL_Exported_Macros DMA2D Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -498,10 +516,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup DMA2D_LL_Exported_Functions DMA2D Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMA2D_LL_EF_Configuration Configuration Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -977,6 +997,7 @@ __STATIC_INLINE uint32_t LL_DMA2D_IsEnabledDeadTime(DMA2D_TypeDef *DMA2Dx) }
/** @defgroup DMA2D_LL_EF_FGND_Configuration Foreground Configuration Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1391,6 +1412,7 @@ __STATIC_INLINE uint32_t LL_DMA2D_FGND_GetChrSubSampling(DMA2D_TypeDef *DMA2Dx) */
/** @defgroup DMA2D_LL_EF_BGND_Configuration Background Configuration Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1782,6 +1804,7 @@ __STATIC_INLINE uint32_t LL_DMA2D_BGND_GetCLUTColorMode(DMA2D_TypeDef *DMA2Dx) /** @defgroup DMA2D_LL_EF_FLAG_MANAGEMENT Flag Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1922,6 +1945,7 @@ __STATIC_INLINE void LL_DMA2D_ClearFlag_TE(DMA2D_TypeDef *DMA2Dx) */
/** @defgroup DMA2D_LL_EF_IT_MANAGEMENT Interruption Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2131,6 +2155,7 @@ __STATIC_INLINE uint32_t LL_DMA2D_IsEnabledIT_TE(DMA2D_TypeDef *DMA2Dx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup DMA2D_LL_EF_Init_Functions Initialization and De-initialization Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_dmamux.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_dmamux.h index 13f81186d8..f0930ee3f5 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_dmamux.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_dmamux.h @@ -35,6 +35,7 @@ extern "C" { #if defined (DMAMUX1) || defined (DMAMUX2)
/** @defgroup DMAMUX_LL DMAMUX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -42,6 +43,7 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup DMAMUX_LL_Private_Constants DMAMUX Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Define used to get DMAMUX CCR register size */
@@ -65,9 +67,11 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup DMAMUX_LL_Exported_Constants DMAMUX Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMAMUX_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_DMAMUX_WriteReg function
* @{
*/
@@ -100,6 +104,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_DMAMUX_ReadReg function
* @{
*/
@@ -132,6 +137,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_DMA_ReadReg and LL_DMAMUX_WriteReg functions
* @{
*/
@@ -142,6 +148,7 @@ extern "C" { */
/** @defgroup DMAMUX_Request_selection DMAMUX Request selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief DMA Request selection
* @{
*/
@@ -316,6 +323,7 @@ extern "C" { /** @defgroup DMAMUX_LL_EC_CHANNEL DMAMUX Channel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX_CHANNEL_0 0x00000000U /*!< DMAMUX1 Channel 0 connected to DMA1 Channel 0 , DMAMUX2 Channel 0 connected to BDMA Channel 0 */
@@ -339,6 +347,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_SYNC_NO Synchronization Signal Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX_SYNC_NO_EVENT 0x00000000U /*!< All requests are blocked */
@@ -350,6 +359,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_SYNC_EVT Synchronization Signal Event
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX1_SYNC_DMAMUX1_CH0_EVT 0x00000000U /*!< DMAMUX1 synchronization Signal is DMAMUX1 Channel0 Event */
@@ -383,6 +393,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_REQUEST_GENERATOR Request Generator Channel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX_REQ_GEN_0 0x00000000U
@@ -398,6 +409,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_REQUEST_GEN_POLARITY External Request Signal Generation Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX_REQ_GEN_NO_EVENT 0x00000000U /*!< No external DMA request generation */
@@ -409,6 +421,7 @@ extern "C" { */
/** @defgroup DMAMUX_LL_EC_REQUEST_GEN External Request Signal Generation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DMAMUX1_REQ_GEN_DMAMUX1_CH0_EVT 0U /*!< DMAMUX1 Request generator Signal is DMAMUX1 Channel0 Event */
@@ -466,10 +479,12 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup DMAMUX_LL_Exported_Macros DMAMUX Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMAMUX_LL_EM_WRITE_READ Common Write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -498,10 +513,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup DMAMUX_LL_Exported_Functions DMAMUX Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup DMAMUX_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1545,6 +1562,7 @@ __STATIC_INLINE uint32_t LL_DMAMUX_GetRequestSignalID(DMAMUX_Channel_TypeDef *DM */
/** @defgroup DMAMUX_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2177,6 +2195,7 @@ __STATIC_INLINE void LL_DMAMUX_ClearFlag_RGO7(DMAMUX_Channel_TypeDef *DMAMUXx) */
/** @defgroup DMAMUX_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_exti.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_exti.h index 4bbbffd5b6..f87db1f535 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_exti.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_exti.h @@ -35,6 +35,7 @@ extern "C" { #if defined (EXTI)
/** @defgroup EXTI_LL EXTI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -44,6 +45,7 @@ extern "C" { /* Private Macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup EXTI_LL_Private_Macros EXTI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -53,6 +55,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup EXTI_LL_ES_INIT EXTI Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -84,10 +87,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup EXTI_LL_Exported_Constants EXTI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup EXTI_LL_EC_LINE LINE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_EXTI_LINE_0 EXTI_IMR1_IM0 /*!< Extended line 0 */
@@ -209,6 +214,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup EXTI_LL_EC_MODE Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_EXTI_MODE_IT ((uint8_t)0x01U) /*!< Cortex-M7 Interrupt Mode */
@@ -230,6 +236,7 @@ typedef struct */
/** @defgroup EXTI_LL_EC_TRIGGER Edge Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_EXTI_TRIGGER_NONE ((uint8_t)0x00U) /*!< No Trigger Mode */
@@ -242,6 +249,7 @@ typedef struct */
/** @defgroup EXTI_LL_D3_PEND_CLR D3 Pend Clear Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_EXTI_D3_PEND_CLR_DMACH6 ((uint8_t)0x00U) /*!< DMA ch6 event selected as D3 domain pendclear source */
@@ -270,10 +278,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup EXTI_LL_Exported_Macros EXTI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup EXTI_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -305,9 +315,11 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup EXTI_LL_Exported_Functions EXTI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup EXTI_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1061,6 +1073,7 @@ __STATIC_INLINE uint32_t LL_C2_EXTI_IsEnabledIT_64_95(uint32_t ExtiLine) */
/** @defgroup EXTI_LL_EF_Event_Management Event_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1809,6 +1822,7 @@ __STATIC_INLINE uint32_t LL_C2_EXTI_IsEnabledEvent_64_95(uint32_t ExtiLine) */
/** @defgroup EXTI_LL_EF_Rising_Trigger_Management Rising_Trigger_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2043,6 +2057,7 @@ __STATIC_INLINE uint32_t LL_EXTI_IsEnabledRisingTrig_64_95(uint32_t ExtiLine) */
/** @defgroup EXTI_LL_EF_Falling_Trigger_Management Falling_Trigger_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2276,6 +2291,7 @@ __STATIC_INLINE uint32_t LL_EXTI_IsEnabledFallingTrig_64_95(uint32_t ExtiLine) */
/** @defgroup EXTI_LL_EF_Software_Interrupt_Management Software_Interrupt_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2361,6 +2377,7 @@ __STATIC_INLINE void LL_EXTI_GenerateSWI_64_95(uint32_t ExtiLine) */
/** @defgroup EXTI_LL_EF_Flag_Management Flag_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3123,6 +3140,7 @@ __STATIC_INLINE uint32_t LL_D3_EXTI_GetPendClearSel_48_63(uint32_t ExtiLine) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup EXTI_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{,
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_fmc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_fmc.h index a45860f1dd..3725af7bf0 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_fmc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_fmc.h @@ -172,6 +172,7 @@ extern "C" { /* Exported typedef ----------------------------------------------------------*/
/** @defgroup FMC_LL_Exported_typedef FMC Low Layer Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -451,10 +452,12 @@ typedef struct */
/** @defgroup FMC_LL_NOR_SRAM_Controller FMC NOR/SRAM Controller
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_NORSRAM_Bank FMC NOR/SRAM Bank
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NORSRAM_BANK1 ((uint32_t)0x00000000)
@@ -466,6 +469,7 @@ typedef struct */
/** @defgroup FMC_Data_Address_Bus_Multiplexing FMC Data Address Bus Multiplexing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_DATA_ADDRESS_MUX_DISABLE ((uint32_t)0x00000000)
@@ -475,6 +479,7 @@ typedef struct */
/** @defgroup FMC_Memory_Type FMC Memory Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_MEMORY_TYPE_SRAM ((uint32_t)0x00000000)
@@ -485,6 +490,7 @@ typedef struct */
/** @defgroup FMC_NORSRAM_Data_Width FMC NORSRAM Data Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NORSRAM_MEM_BUS_WIDTH_8 ((uint32_t)0x00000000)
@@ -495,6 +501,7 @@ typedef struct */
/** @defgroup FMC_NORSRAM_Flash_Access FMC NOR/SRAM Flash Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NORSRAM_FLASH_ACCESS_ENABLE ((uint32_t)0x00000040)
@@ -504,6 +511,7 @@ typedef struct */
/** @defgroup FMC_Burst_Access_Mode FMC Burst Access Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_BURST_ACCESS_MODE_DISABLE ((uint32_t)0x00000000)
@@ -513,6 +521,7 @@ typedef struct */
/** @defgroup FMC_Wait_Signal_Polarity FMC Wait Signal Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WAIT_SIGNAL_POLARITY_LOW ((uint32_t)0x00000000)
@@ -522,6 +531,7 @@ typedef struct */
/** @defgroup FMC_Wait_Timing FMC Wait Timing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WAIT_TIMING_BEFORE_WS ((uint32_t)0x00000000)
@@ -531,6 +541,7 @@ typedef struct */
/** @defgroup FMC_Write_Operation FMC Write Operation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WRITE_OPERATION_DISABLE ((uint32_t)0x00000000)
@@ -540,6 +551,7 @@ typedef struct */
/** @defgroup FMC_Wait_Signal FMC Wait Signal
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WAIT_SIGNAL_DISABLE ((uint32_t)0x00000000)
@@ -549,6 +561,7 @@ typedef struct */
/** @defgroup FMC_Extended_Mode FMC Extended Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_EXTENDED_MODE_DISABLE ((uint32_t)0x00000000)
@@ -558,6 +571,7 @@ typedef struct */
/** @defgroup FMC_AsynchronousWait FMC Asynchronous Wait
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_ASYNCHRONOUS_WAIT_DISABLE ((uint32_t)0x00000000)
@@ -567,6 +581,7 @@ typedef struct */
/** @defgroup FMC_Page_Size FMC Page Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_PAGE_SIZE_NONE ((uint32_t)0x00000000)
@@ -579,6 +594,7 @@ typedef struct */
/** @defgroup FMC_Write_Burst FMC Write Burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WRITE_BURST_DISABLE ((uint32_t)0x00000000)
@@ -588,6 +604,7 @@ typedef struct */
/** @defgroup FMC_Continous_Clock FMC Continuous Clock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_CONTINUOUS_CLOCK_SYNC_ONLY ((uint32_t)0x00000000)
@@ -597,6 +614,7 @@ typedef struct */
/** @defgroup FMC_Write_FIFO FMC Write FIFO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_WRITE_FIFO_DISABLE ((uint32_t)FMC_BCR1_WFDIS)
@@ -606,6 +624,7 @@ typedef struct */
/** @defgroup FMC_Access_Mode FMC Access Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_ACCESS_MODE_A ((uint32_t)0x00000000)
@@ -622,9 +641,11 @@ typedef struct /** @defgroup FMC_LL_NAND_Controller FMC NAND Controller
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_NAND_Bank FMC NAND Bank
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NAND_BANK3 ((uint32_t)0x00000100)
@@ -633,6 +654,7 @@ typedef struct */
/** @defgroup FMC_Wait_feature FMC Wait feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NAND_WAIT_FEATURE_DISABLE ((uint32_t)0x00000000)
@@ -642,6 +664,7 @@ typedef struct */
/** @defgroup FMC_PCR_Memory_Type FMC PCR Memory Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_PCR_MEMORY_TYPE_NAND ((uint32_t)0x00000008)
@@ -650,6 +673,7 @@ typedef struct */
/** @defgroup FMC_NAND_Data_Width FMC NAND Data Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NAND_MEM_BUS_WIDTH_8 ((uint32_t)0x00000000)
@@ -659,6 +683,7 @@ typedef struct */
/** @defgroup FMC_ECC FMC ECC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NAND_ECC_DISABLE ((uint32_t)0x00000000)
@@ -668,6 +693,7 @@ typedef struct */
/** @defgroup FMC_ECC_Page_Size FMC ECC Page Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_NAND_ECC_PAGE_SIZE_256BYTE ((uint32_t)0x00000000)
@@ -685,9 +711,11 @@ typedef struct */
/** @defgroup FMC_LL_SDRAM_Controller FMC SDRAM Controller
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_SDRAM_Bank FMC SDRAM Bank
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_BANK1 ((uint32_t)0x00000000)
@@ -697,6 +725,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Column_Bits_number FMC SDRAM Column Bits number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_COLUMN_BITS_NUM_8 ((uint32_t)0x00000000)
@@ -708,6 +737,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Row_Bits_number FMC SDRAM Row Bits number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_ROW_BITS_NUM_11 ((uint32_t)0x00000000)
@@ -718,6 +748,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Memory_Bus_Width FMC SDRAM Memory Bus Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_MEM_BUS_WIDTH_8 ((uint32_t)0x00000000)
@@ -728,6 +759,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Internal_Banks_Number FMC SDRAM Internal Banks Number
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_INTERN_BANKS_NUM_2 ((uint32_t)0x00000000)
@@ -737,6 +769,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_CAS_Latency FMC SDRAM CAS Latency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_CAS_LATENCY_1 ((uint32_t)0x00000080)
@@ -747,6 +780,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Write_Protection FMC SDRAM Write Protection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_WRITE_PROTECTION_DISABLE ((uint32_t)0x00000000)
@@ -756,6 +790,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Clock_Period FMC SDRAM Clock Period
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_CLOCK_DISABLE ((uint32_t)0x00000000)
@@ -766,6 +801,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Read_Burst FMC SDRAM Read Burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_RBURST_DISABLE ((uint32_t)0x00000000)
@@ -775,6 +811,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Read_Pipe_Delay FMC SDRAM Read Pipe Delay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_RPIPE_DELAY_0 ((uint32_t)0x00000000)
@@ -785,6 +822,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Command_Mode FMC SDRAM Command Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_CMD_NORMAL_MODE ((uint32_t)0x00000000)
@@ -799,6 +837,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Command_Target FMC SDRAM Command Target
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_CMD_TARGET_BANK2 FMC_SDCMR_CTB2
@@ -809,6 +848,7 @@ typedef struct */
/** @defgroup FMC_SDRAM_Mode_Status FMC SDRAM Mode Status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_SDRAM_NORMAL_MODE ((uint32_t)0x00000000)
@@ -824,6 +864,7 @@ typedef struct /** @defgroup FMC_LL_Interrupt_definition FMC Low Layer Interrupt definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_IT_RISING_EDGE ((uint32_t)0x00000008)
@@ -835,6 +876,7 @@ typedef struct */
/** @defgroup FMC_LL_Flag_definition FMC Low Layer Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define FMC_FLAG_RISING_EDGE ((uint32_t)0x00000001)
@@ -858,6 +900,7 @@ typedef struct /* Private macro -------------------------------------------------------------*/
/** @defgroup FMC_LL_Private_Macros FMC_LL Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -872,6 +915,7 @@ typedef struct */
#define __FMC_DISABLE() (FMC_Bank1_R->BTCR[0] &= ~FMC_BCR1_FMCEN)
/** @defgroup FMC_LL_NOR_Macros FMC NOR/SRAM Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle NOR device enable/disable and read/write operations
* @{
*/
@@ -897,6 +941,7 @@ typedef struct */
/** @defgroup FMC_LL_NAND_Macros FMC NAND Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle NAND device enable/disable
* @{
*/
@@ -921,6 +966,7 @@ typedef struct */
/** @defgroup FMC_LL_NAND_Interrupt FMC NAND Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle NAND interrupts
* @{
*/
@@ -982,6 +1028,7 @@ typedef struct /** @defgroup FMC_LL_SDRAM_Interrupt FMC SDRAM Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle SDRAM interrupts
* @{
*/
@@ -1041,13 +1088,16 @@ typedef struct /* Private functions ---------------------------------------------------------*/
/** @defgroup FMC_LL_Private_Functions FMC LL Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_LL_NORSRAM NOR SRAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_LL_NORSRAM_Private_Functions_Group1 NOR SRAM Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_NORSRAM_Init(FMC_NORSRAM_TypeDef *Device, FMC_NORSRAM_InitTypeDef *Init);
@@ -1059,6 +1109,7 @@ HAL_StatusTypeDef FMC_NORSRAM_DeInit(FMC_NORSRAM_TypeDef *Device, FMC_NORSRAM_E */
/** @defgroup FMC_LL_NORSRAM_Private_Functions_Group2 NOR SRAM Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_NORSRAM_WriteOperation_Enable(FMC_NORSRAM_TypeDef *Device, uint32_t Bank);
@@ -1071,9 +1122,11 @@ HAL_StatusTypeDef FMC_NORSRAM_WriteOperation_Disable(FMC_NORSRAM_TypeDef *Devic */
/** @defgroup FMC_LL_NAND NAND
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_LL_NAND_Private_Functions_Group1 NAND Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_NAND_Init(FMC_NAND_TypeDef *Device, FMC_NAND_InitTypeDef *Init);
@@ -1085,6 +1138,7 @@ HAL_StatusTypeDef FMC_NAND_DeInit(FMC_NAND_TypeDef *Device, uint32_t Bank); */
/** @defgroup FMC_LL_NAND_Private_Functions_Group2 NAND Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_NAND_ECC_Enable(FMC_NAND_TypeDef *Device, uint32_t Bank);
@@ -1099,9 +1153,11 @@ HAL_StatusTypeDef FMC_NAND_GetECC(FMC_NAND_TypeDef *Device, uint32_t *ECCval, u /** @defgroup FMC_LL_SDRAM SDRAM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup FMC_LL_SDRAM_Private_Functions_Group1 SDRAM Initialization/de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_SDRAM_Init(FMC_SDRAM_TypeDef *Device, FMC_SDRAM_InitTypeDef *Init);
@@ -1112,6 +1168,7 @@ HAL_StatusTypeDef FMC_SDRAM_DeInit(FMC_SDRAM_TypeDef *Device, uint32_t Bank); */
/** @defgroup FMC_LL_SDRAM_Private_Functions_Group2 SDRAM Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef FMC_SDRAM_WriteProtection_Enable(FMC_SDRAM_TypeDef *Device, uint32_t Bank);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_gpio.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_gpio.h index bc7121af7e..82a9c5833a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_gpio.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_gpio.h @@ -35,6 +35,7 @@ extern "C" { #if defined (GPIOA) || defined (GPIOB) || defined (GPIOC) || defined (GPIOD) || defined (GPIOE) || defined (GPIOF) || defined (GPIOG) || defined (GPIOH) || defined (GPIOI) || defined (GPIOJ) || defined (GPIOK)
/** @defgroup GPIO_LL GPIO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -44,6 +45,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup GPIO_LL_Private_Macros GPIO Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -55,6 +57,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup GPIO_LL_ES_INIT GPIO Exported Init structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -99,10 +102,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup GPIO_LL_Exported_Constants GPIO Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_LL_EC_PIN PIN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_PIN_0 GPIO_BSRR_BS0 /*!< Select pin 0 */
@@ -132,6 +137,7 @@ typedef struct */
/** @defgroup GPIO_LL_EC_MODE Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_MODE_INPUT (0x00000000U) /*!< Select input mode */
@@ -143,6 +149,7 @@ typedef struct */
/** @defgroup GPIO_LL_EC_OUTPUT Output Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_OUTPUT_PUSHPULL (0x00000000U) /*!< Select push-pull as output type */
@@ -152,6 +159,7 @@ typedef struct */
/** @defgroup GPIO_LL_EC_SPEED Output Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_SPEED_FREQ_LOW (0x00000000U) /*!< Select I/O low output speed */
@@ -168,6 +176,7 @@ typedef struct /** @defgroup GPIO_LL_EC_PULL Pull Up Pull Down
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_PULL_NO (0x00000000U) /*!< Select I/O no pull */
@@ -178,6 +187,7 @@ typedef struct */
/** @defgroup GPIO_LL_EC_AF Alternate Function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_GPIO_AF_0 (0x0000000U) /*!< Select alternate function 0 */
@@ -206,10 +216,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup GPIO_LL_Exported_Macros GPIO Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -239,10 +251,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup GPIO_LL_Exported_Functions GPIO Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup GPIO_LL_EF_Port_Configuration Port Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -763,6 +777,7 @@ __STATIC_INLINE uint32_t LL_GPIO_IsAnyPinLocked(GPIO_TypeDef *GPIOx) */
/** @defgroup GPIO_LL_EF_Data_Access Data Access
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -951,6 +966,7 @@ __STATIC_INLINE void LL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint32_t PinMask) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup GPIO_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_hrtim.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_hrtim.h index b63077568c..948bd70c5e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_hrtim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_hrtim.h @@ -35,12 +35,14 @@ extern "C" { #if defined (HRTIM1)
/** @defgroup HRTIM_LL HRTIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup HRTIM_LL_Private_Variables HRTIM Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static const uint16_t REG_OFFSET_TAB_TIMER[] =
@@ -210,6 +212,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = /* Private constants ---------------------------------------------------------*/
/** @defgroup HRTIM_LL_Private_Constants HRTIM Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HRTIM_CR1_UDIS_MASK ((uint32_t)(HRTIM_CR1_MUDIS |\
@@ -283,10 +286,12 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup HRTIM_LL_Exported_Constants HRTIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HRTIM_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_HRTIM_ReadReg function
* @{
*/
@@ -325,6 +330,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_HRTIM_ReadReg and LL_HRTIM_WriteReg functions
* @{
*/
@@ -363,6 +369,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_SYNCIN_SRC SYNCHRONIZATION INPUT SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining defining the synchronization input source.
*/
@@ -374,6 +381,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_SYNCOUT_SRC SYNCHRONIZATION OUTPUT SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the source and event to be sent on the synchronization output.
*/
@@ -386,6 +394,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_SYNCOUT_POLARITY SYNCHRONIZATION OUTPUT POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the routing and conditioning of the synchronization output event.
*/
@@ -397,6 +406,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_TIMER TIMER ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying a timing unit.
*/
@@ -417,6 +427,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUTPUT OUTPUT ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying an HRTIM output.
*/
@@ -435,6 +446,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_COMPAREUNIT COMPARE UNIT ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying a compare unit.
*/
@@ -445,6 +457,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CAPTUREUNIT CAPTURE UNIT ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying a capture unit.
*/
@@ -455,6 +468,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_FAULT FAULT ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying a fault channel.
*/
@@ -468,6 +482,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_EVENT EXTERNAL EVENT ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying an external event channel.
*/
@@ -486,6 +501,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUTPUTSTATE OUTPUT STATE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the state of an HRTIM output.
*/
@@ -497,6 +513,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_ADCTRIG ADC TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants identifying an ADC trigger.
*/
@@ -509,6 +526,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_ADCTRIG_UPDATE ADC TRIGGER UPDATE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief constants defining the source triggering the update of the HRTIM_ADCxR register (transfer from preload to active register).
*/
@@ -523,6 +541,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_ADCTRIG_SRC13 ADC TRIGGER 1/3 SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief constants defining the events triggering ADC conversion for ADC Triggers 1 and 3.
*/
@@ -564,6 +583,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_ADCTRIG_SRC24 ADC TRIGGER 2/4 SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief constants defining the events triggering ADC conversion for ADC Triggers 2 and 4.
*/
@@ -605,6 +625,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_PRESCALERRATIO PRESCALER RATIO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer high-resolution clock prescaler ratio.
*/
@@ -616,6 +637,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_MODE COUNTER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining timer counter operating mode.
*/
@@ -627,6 +649,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_DACTRIG DAC TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the DAC synchronization event is sent.
*/
@@ -639,6 +662,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_UPDATETRIG UPDATE TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the registers update is done synchronously with any other timer or master update.
*/
@@ -656,6 +680,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_UPDATEGATING UPDATE GATING
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining how the update occurs relatively to the burst DMA transaction and the external update request on update enable inputs 1 to 3.
*/
@@ -673,6 +698,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_COMPAREMODE COMPARE MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the compare register is behaving in regular mode (compare match issued as soon as counter equal compare) or in auto-delayed mode.
*/
@@ -685,6 +711,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_RESETTRIG RESET TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to trigger the reset of the timer counter.
*/
@@ -724,6 +751,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CAPTURETRIG CAPTURE TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to trigger the capture of the timing unit counter.
*/
@@ -764,6 +792,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_DLYPRT DELAYED PROTECTION (DLYPRT) MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining all possible delayed protection modes for a timer (also define the source and outputs on which the delayed protection schemes are applied).
*/
@@ -789,6 +818,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_BURSTMODE BURST MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining how the timer behaves during a burst mode operation.
*/
@@ -799,6 +829,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_BURSTDMA BURST DMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the registers that can be written during a burst DMA operation.
*/
@@ -839,6 +870,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CPPSTAT CURRENT PUSH-PULL STATUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the signal is currently applied in push-pull mode.
*/
@@ -849,6 +881,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_IPPSTAT IDLE PUSH-PULL STATUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining on which output the signal was applied, in push-pull mode balanced fault mode or delayed idle mode, when the protection was triggered.
*/
@@ -859,6 +892,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_TIM_EEFLTR TIMER EXTERNAL EVENT FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the event filtering applied to external events by a timer.
*/
@@ -883,6 +917,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_TIM_LATCHSTATUS TIMER EXTERNAL EVENT LATCH STATUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the external event is memorized (latched) and generated as soon as the blanking period is completed or the window ends.
*/
@@ -893,6 +928,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_DT_PRESCALER DEADTIME PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining division ratio between the timer clock frequency (fHRTIM) and the deadtime generator clock (fDTG).
*/
@@ -909,6 +945,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_DT_RISING_SIGN DEADTIME RISING SIGN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the deadtime is positive or negative (overlapping signal) on rising edge.
*/
@@ -919,6 +956,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_DT_FALLING_SIGN DEADTIME FALLING SIGN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether the deadtime is positive or negative (overlapping signal) on falling edge.
*/
@@ -929,6 +967,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CHP_PRESCALER CHOPPER MODE PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the frequency of the generated high frequency carrier (fCHPFRQ).
*/
@@ -953,6 +992,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CHP_DUTYCYCLE CHOPPER MODE DUTY CYCLE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the duty cycle of the generated high frequency carrier. Duty cycle can be adjusted by 1/8 step (from 0/8 up to 7/8).
*/
@@ -969,6 +1009,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CHP_PULSEWIDTH CHOPPER MODE PULSE WIDTH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the pulse width of the first pulse of the generated high frequency carrier.
*/
@@ -993,6 +1034,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_CROSSBAR_INPUT CROSSBAR INPUT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be selected to configure the set/reset crossbar of a timer output.
*/
@@ -1033,6 +1075,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_POLARITY OUPUT_POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of a timer output.
*/
@@ -1043,6 +1086,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_IDLEMODE OUTPUT IDLE MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not the timer output transition to its IDLE state when burst mode is entered.
*/
@@ -1053,6 +1097,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_HALF_MODE HALF MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the half mode of an HRTIM Timer instance.
*/
@@ -1063,6 +1108,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_IDLELEVEL OUTPUT IDLE LEVEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the output level when output is in IDLE state
*/
@@ -1073,6 +1119,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_FAULTSTATE OUTPUT FAULT STATE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the output level when output is in FAULT state.
*/
@@ -1085,6 +1132,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_CHOPPERMODE OUTPUT CHOPPER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not chopper mode is enabled for a timer output.
*/
@@ -1095,6 +1143,7 @@ static const uint8_t REG_SHIFT_TAB_FLTxE[] = */
/** @defgroup HRTIM_LL_EC_OUT_BM_ENTRYMODE OUTPUT BURST MODE ENTRY MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the idle state entry mode during a burst mode operation. It is possible to delay the burst mode entry and force the output to an inactive state
during a programmable period before the output takes its idle state.
@@ -1105,6 +1154,7 @@ during a programmable period before the output takes its idle state. * @}
*/
/** @defgroup HRTIM_LL_EC_OUT_LEVEL OUTPUT LEVEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the level of a timer output.
*/
@@ -1115,6 +1165,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_EE_SRC EXTERNAL EVENT SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining available sources associated to external events.
*/
@@ -1126,6 +1177,7 @@ during a programmable period before the output takes its idle state. * @}
*/
/** @defgroup HRTIM_LL_EC_EE_POLARITY EXTERNAL EVENT POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of an external event.
*/
@@ -1136,6 +1188,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_EE_SENSITIVITY EXTERNAL EVENT SENSITIVITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the sensitivity (level-sensitive or edge-sensitive) of an external event.
*/
@@ -1148,6 +1201,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_EE_FASTMODE EXTERNAL EVENT FAST MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether or not an external event is programmed in fast mode.
*/
@@ -1158,6 +1212,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_EE_FILTER EXTERNAL EVENT DIGITAL FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the frequency used to sample an external event input (fSAMPLING) and the length (N) of the digital filter applied.
*/
@@ -1182,6 +1237,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_EE_PRESCALER EXTERNAL EVENT PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining division ratio between the timer clock frequency (fHRTIM) and the external event signal sampling clock (fEEVS) used by the digital filters.
*/
@@ -1194,6 +1250,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_FLT_SRC FAULT SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining whether a faults is be triggered by any external or internal fault source.
*/
@@ -1204,6 +1261,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_FLT_POLARITY FAULT POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the polarity of a fault event.
*/
@@ -1214,6 +1272,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_FLT_FILTER FAULT DIGITAL FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the frequency used to sample the fault input (fSAMPLING) and the length (N) of the digital filter applied.
*/
@@ -1238,6 +1297,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_FLT_PRESCALER BURST FAULT PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the division ratio between the timer clock frequency (fHRTIM) and the fault signal sampling clock (fFLTS) used by the digital filters.
*/
@@ -1250,6 +1310,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_BM_MODE BURST MODE OPERATING MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining if the burst mode is entered once or if it is continuously operating.
*/
@@ -1260,6 +1321,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_BM_CLKSRC BURST MODE CLOCK SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the clock source for the burst mode counter.
*/
@@ -1278,6 +1340,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_BM_PRESCALER BURST MODE PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the prescaling ratio of the fHRTIM clock for the burst mode controller (fBRST).
*/
@@ -1302,6 +1365,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_BM_TRIG HRTIM BURST MODE TRIGGER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the events that can be used to trig the burst mode operation.
*/
@@ -1342,6 +1406,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EC_BM_STATUS HRTIM BURST MODE STATUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
* @brief Constants defining the operating state of the burst mode controller.
*/
@@ -1357,10 +1422,12 @@ during a programmable period before the output takes its idle state. /* Exported macro ------------------------------------------------------------*/
/** @defgroup HRTIM_LL_Exported_Macros HRTIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HRTIM_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1385,6 +1452,7 @@ during a programmable period before the output takes its idle state. */
/** @defgroup HRTIM_LL_EM_Exported_Macros Exported_Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1409,9 +1477,11 @@ during a programmable period before the output takes its idle state. /* Exported functions --------------------------------------------------------*/
/** @defgroup HRTIM_LL_Exported_Functions HRTIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HRTIM_LL_EF_HRTIM_Control HRTIM_Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2476,6 +2546,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_GetADCTrigSrc(HRTIM_TypeDef *HRTIMx, uint32_t */
/** @defgroup HRTIM_LL_EF_HRTIM_Timer_Control HRTIM_Timer_Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4680,6 +4751,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_TIM_GetEventLatchStatus(HRTIM_TypeDef *HRTIMx, */
/** @defgroup HRTIM_LL_EF_Dead_Time_Configuration Dead_Time_Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5023,6 +5095,7 @@ __STATIC_INLINE void LL_HRTIM_DT_LockFallingSign(HRTIM_TypeDef *HRTIMx, uint32_t */
/** @defgroup HRTIM_LL_EF_Chopper_Mode_Configuration Chopper_Mode_Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5270,6 +5343,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_CHP_GetPulseWidth(HRTIM_TypeDef *HRTIMx, uint3 */
/** @defgroup HRTIM_LL_EF_Output_Management Output_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6253,6 +6327,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_OUT_GetLevel(HRTIM_TypeDef *HRTIMx, uint32_t O */
/** @defgroup HRTIM_LL_EF_External_Event_management External_Event_management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6740,6 +6815,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_EE_GetPrescaler(HRTIM_TypeDef *HRTIMx) */
/** @defgroup HRTIM_LL_EF_Fault_management Fault_management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -7100,6 +7176,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_FLT_IsEnabled(HRTIM_TypeDef *HRTIMx, uint32_t */
/** @defgroup HRTIM_LL_EF_Burst_Mode_management Burst_Mode_management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -7569,6 +7646,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_BM_GetStatus(HRTIM_TypeDef *HRTIMx) */
/** @defgroup HRTIM_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -8352,6 +8430,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_IsActiveFlag_DLYPRT(HRTIM_TypeDef *HRTIMx, uin */
/** @defgroup HRTIM_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -9514,6 +9593,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_IsEnabledIT_DLYPRT(HRTIM_TypeDef *HRTIMx, uint */
/** @defgroup HRTIM_LL_EF_DMA_Management DMA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -10446,6 +10526,7 @@ __STATIC_INLINE uint32_t LL_HRTIM_IsEnabledDMAReq_DLYPRT(HRTIM_TypeDef *HRTIMx, #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup HRTIM_LL_LL_EF_Init In-initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
ErrorStatus LL_HRTIM_DeInit(HRTIM_TypeDef* HRTIMx);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_hsem.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_hsem.h index d0256f3287..3cb92f487f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_hsem.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_hsem.h @@ -35,6 +35,7 @@ extern "C" { #if defined(HSEM)
/** @defgroup HSEM_LL HSEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -47,10 +48,12 @@ extern "C" { /* Exported constants --------------------------------------------------------*/
/** @defgroup HSEM_LL_Exported_Constants HSEM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HSEM_LL_EC_COREID COREID Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_HSEM_COREID_NONE 0U
@@ -64,6 +67,7 @@ extern "C" { */
/** @defgroup HSEM_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_HSEM_ReadReg function
* @{
*/
@@ -115,10 +119,12 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup HSEM_LL_Exported_Macros HSEM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HSEM_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -148,10 +154,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup HSEM_LL_Exported_Functions HSEM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup HSEM_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -309,6 +317,7 @@ __STATIC_INLINE void LL_HSEM_ResetAllLock(HSEM_TypeDef *HSEMx, uint32_t key, uin */
/** @defgroup HSEM_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -594,6 +603,7 @@ __STATIC_INLINE uint32_t LL_HSEM_IsEnabledIT_C2IER(HSEM_TypeDef *HSEMx, uint32_t */
/** @defgroup HSEM_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h index 9fa0420ec8..fdfe1d8811 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_i2c.h @@ -35,6 +35,7 @@ extern "C" { #if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4)
/** @defgroup I2C_LL I2C
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup I2C_LL_Private_Constants I2C Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -52,6 +54,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup I2C_LL_Private_Macros I2C Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -62,6 +65,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup I2C_LL_ES_INIT I2C Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -109,10 +113,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup I2C_LL_Exported_Constants I2C Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_I2C_WriteReg function
* @{
*/
@@ -130,6 +136,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_I2C_ReadReg function
* @{
*/
@@ -153,6 +160,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_I2C_ReadReg and LL_I2C_WriteReg functions
* @{
*/
@@ -168,6 +176,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_PERIPHERAL_MODE Peripheral Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_MODE_I2C 0x00000000U /*!< I2C Master or Slave mode */
@@ -179,6 +188,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_ANALOGFILTER_SELECTION Analog Filter Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_ANALOGFILTER_ENABLE 0x00000000U /*!< Analog filter is enabled. */
@@ -188,6 +198,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_ADDRESSING_MODE Master Addressing Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_ADDRESSING_MODE_7BIT 0x00000000U /*!< Master operates in 7-bit addressing mode. */
@@ -197,6 +208,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_OWNADDRESS1 Own Address 1 Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_OWNADDRESS1_7BIT 0x00000000U /*!< Own address 1 is a 7-bit address. */
@@ -206,6 +218,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_OWNADDRESS2 Own Address 2 Masks
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_OWNADDRESS2_NOMASK I2C_OAR2_OA2NOMASK /*!< Own Address2 No mask. */
@@ -221,6 +234,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_I2C_ACKNOWLEDGE Acknowledge Generation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_ACK 0x00000000U /*!< ACK is sent after current received byte. */
@@ -230,6 +244,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_ADDRSLAVE Slave Address Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_ADDRSLAVE_7BIT 0x00000000U /*!< Slave Address in 7-bit. */
@@ -239,6 +254,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_REQUEST Transfer Request Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_REQUEST_WRITE 0x00000000U /*!< Master request a write transfer. */
@@ -248,6 +264,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_MODE Transfer End Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_MODE_RELOAD I2C_CR2_RELOAD /*!< Enable I2C Reload mode. */
@@ -263,6 +280,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_GENERATE Start And Stop Generation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_GENERATE_NOSTARTSTOP 0x00000000U /*!< Don't Generate Stop and Start condition. */
@@ -278,6 +296,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_DIRECTION Read Write Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_DIRECTION_WRITE 0x00000000U /*!< Write transfer request by master, slave enters receiver mode. */
@@ -287,6 +306,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_DMA_REG_DATA DMA Register Data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_DMA_REG_DATA_TRANSMIT 0x00000000U /*!< Get address of data register used for transmission */
@@ -296,6 +316,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_SMBUS_TIMEOUTA_MODE SMBus TimeoutA Mode SCL SDA Timeout
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW 0x00000000U /*!< TimeoutA is used to detect SCL low level timeout. */
@@ -305,6 +326,7 @@ typedef struct */
/** @defgroup I2C_LL_EC_SMBUS_TIMEOUT_SELECTION SMBus Timeout Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2C_SMBUS_TIMEOUTA I2C_TIMEOUTR_TIMOUTEN /*!< TimeoutA enable bit */
@@ -320,10 +342,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup I2C_LL_Exported_Macros I2C Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -348,6 +372,7 @@ typedef struct */
/** @defgroup I2C_LL_EM_CONVERT_TIMINGS Convert SDA SCL timings
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -375,10 +400,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup I2C_LL_Exported_Functions I2C Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2C_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1234,6 +1261,7 @@ __STATIC_INLINE uint32_t LL_I2C_IsEnabledSMBusTimeout(I2C_TypeDef *I2Cx, uint32_ */
/** @defgroup I2C_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1497,6 +1525,7 @@ __STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_ERR(I2C_TypeDef *I2Cx) */
/** @defgroup I2C_LL_EF_FLAG_management FLAG_management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1824,6 +1853,7 @@ __STATIC_INLINE void LL_I2C_ClearSMBusFlag_ALERT(I2C_TypeDef *I2Cx) */
/** @defgroup I2C_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2192,6 +2222,7 @@ __STATIC_INLINE void LL_I2C_TransmitData8(I2C_TypeDef *I2Cx, uint8_t Data) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup I2C_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_iwdg.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_iwdg.h index 8a8e2a138a..fe2e3438a9 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_iwdg.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_iwdg.h @@ -35,6 +35,7 @@ extern "C" { #if defined(IWDG1) || defined(IWDG2)
/** @defgroup IWDG_LL IWDG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup IWDG_LL_Private_Constants IWDG Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_IWDG_KEY_RELOAD 0x0000AAAAU /*!< IWDG Reload Counter Enable */
@@ -58,10 +60,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup IWDG_LL_Exported_Constants IWDG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IWDG_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_IWDG_ReadReg function
* @{
*/
@@ -73,6 +77,7 @@ extern "C" { */
/** @defgroup IWDG_LL_EC_PRESCALER Prescaler Divider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_IWDG_PRESCALER_4 0x00000000U /*!< Divider by 4 */
@@ -92,10 +97,12 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup IWDG_LL_Exported_Macros IWDG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IWDG_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -126,9 +133,11 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup IWDG_LL_Exported_Functions IWDG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup IWDG_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -265,6 +274,7 @@ __STATIC_INLINE uint32_t LL_IWDG_GetWindow(IWDG_TypeDef *IWDGx) */
/** @defgroup IWDG_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_lptim.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_lptim.h index fd04c48699..d90cb1b66b 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_lptim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_lptim.h @@ -35,6 +35,7 @@ extern "C" { #if defined (LPTIM1) || defined (LPTIM2) || defined (LPTIM3) || defined (LPTIM4) || defined (LPTIM5)
/** @defgroup LPTIM_LL LPTIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -46,6 +47,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPTIM_LL_Private_Macros LPTIM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -56,6 +58,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPTIM_LL_ES_INIT LPTIM Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -92,10 +95,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup LPTIM_LL_Exported_Constants LPTIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPTIM_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_LPTIM_ReadReg function
* @{
*/
@@ -111,6 +116,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_LPTIM_ReadReg and LL_LPTIM_WriteReg functions
* @{
*/
@@ -126,6 +132,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_OPERATING_MODE Operating Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_OPERATING_MODE_CONTINUOUS LPTIM_CR_CNTSTRT /*!<LP Timer starts in continuous mode*/
@@ -135,6 +142,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_UPDATE_MODE Update Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_UPDATE_MODE_IMMEDIATE 0x00000000U /*!<Preload is disabled: registers are updated after each APB bus write access*/
@@ -144,6 +152,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_COUNTER_MODE Counter Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_COUNTER_MODE_INTERNAL 0x00000000U /*!<The counter is incremented following each internal clock pulse*/
@@ -153,6 +162,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_OUTPUT_WAVEFORM Output Waveform Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_OUTPUT_WAVEFORM_PWM 0x00000000U /*!<LPTIM generates either a PWM waveform or a One pulse waveform depending on chosen operating mode CONTINOUS or SINGLE*/
@@ -162,6 +172,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_OUTPUT_POLARITY Output Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_OUTPUT_POLARITY_REGULAR 0x00000000U /*!<The LPTIM output reflects the compare results between LPTIMx_ARR and LPTIMx_CMP registers*/
@@ -171,6 +182,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_PRESCALER Prescaler Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_PRESCALER_DIV1 0x00000000U /*!<Prescaler division factor is set to 1*/
@@ -186,6 +198,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_TRIG_SOURCE Trigger Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_TRIG_SOURCE_GPIO 0x00000000U /*!<External input trigger is connected to TIMx_ETR input*/
@@ -212,6 +225,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_TRIG_FILTER Trigger Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_TRIG_FILTER_NONE 0x00000000U /*!<Any trigger active level change is considered as a valid trigger*/
@@ -223,6 +237,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_TRIG_POLARITY Trigger Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_TRIG_POLARITY_RISING LPTIM_CFGR_TRIGEN_0 /*!<LPTIM counter starts when a rising edge is detected*/
@@ -233,6 +248,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_CLK_SOURCE Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_CLK_SOURCE_INTERNAL 0x00000000U /*!<LPTIM is clocked by internal clock source (APB clock or any of the embedded oscillators)*/
@@ -242,6 +258,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_CLK_FILTER Clock Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_CLK_FILTER_NONE 0x00000000U /*!<Any external clock signal level change is considered as a valid transition*/
@@ -253,6 +270,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_CLK_POLARITY Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_CLK_POLARITY_RISING 0x00000000U /*!< The rising edge is the active edge used for counting*/
@@ -263,6 +281,7 @@ typedef struct */
/** @defgroup LPTIM_LL_EC_ENCODER_MODE Encoder Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_ENCODER_MODE_RISING 0x00000000U /*!< The rising edge is the active edge used for counting*/
@@ -273,6 +292,7 @@ typedef struct */
/** @defgroup LPTIM_EC_INPUT1_SRC Input1 Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_INPUT1_SRC_GPIO 0x00000000U /*!< For LPTIM1 and LPTIM2 */
@@ -286,6 +306,7 @@ typedef struct */
/** @defgroup LPTIM_EC_INPUT2_SRC Input2 Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPTIM_INPUT2_SRC_GPIO 0x00000000U /*!< For LPTIM1 */
@@ -300,10 +321,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup LPTIM_LL_Exported_Macros LPTIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPTIM_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -333,11 +356,13 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup LPTIM_LL_Exported_Functions LPTIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPTIM_LL_EF_Init Initialisation and deinitialisation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -351,6 +376,7 @@ void LL_LPTIM_Disable(LPTIM_TypeDef *LPTIMx); #endif /* USE_FULL_LL_DRIVER */
/** @defgroup LPTIM_LL_EF_LPTIM_Configuration LPTIM Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -730,6 +756,7 @@ __STATIC_INLINE void LL_LPTIM_SetInput2Src(LPTIM_TypeDef *LPTIMx, uint32_t Src) */
/** @defgroup LPTIM_LL_EF_Trigger_Configuration Trigger Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -902,6 +929,7 @@ __STATIC_INLINE uint32_t LL_LPTIM_GetTriggerPolarity(LPTIM_TypeDef *LPTIMx) */
/** @defgroup LPTIM_LL_EF_Clock_Configuration Clock Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -994,6 +1022,7 @@ __STATIC_INLINE uint32_t LL_LPTIM_GetClockFilter(LPTIM_TypeDef *LPTIMx) */
/** @defgroup LPTIM_LL_EF_Encoder_Mode Encoder Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1071,6 +1100,7 @@ __STATIC_INLINE uint32_t LL_LPTIM_IsEnabledEncoderMode(LPTIM_TypeDef *LPTIMx) */
/** @defgroup LPTIM_LL_EF_FLAG_Management FLAG Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1233,6 +1263,7 @@ __STATIC_INLINE uint32_t LL_LPTIM_IsActiveFlag_DOWN(LPTIM_TypeDef *LPTIMx) */
/** @defgroup LPTIM_LL_EF_IT_Management Interrupt Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_lpuart.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_lpuart.h index 94896df308..6f3a2cfaca 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_lpuart.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_lpuart.h @@ -35,12 +35,14 @@ extern "C" { #if defined (LPUART1)
/** @defgroup LPUART_LL LPUART
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup LPUART_LL_Private_Variables LPUART Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Array used to get the LPUART prescaler division decimal values versus @ref LPUART_LL_EC_PRESCALER values */
@@ -65,6 +67,7 @@ static const uint16_t LPUART_PRESCALER_TAB[] = /* Private constants ---------------------------------------------------------*/
/** @defgroup LPUART_LL_Private_Constants LPUART Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Defines used in Baud Rate related macros and corresponding register setting computation */
@@ -79,6 +82,7 @@ static const uint16_t LPUART_PRESCALER_TAB[] = /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPUART_LL_Private_Macros LPUART Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -89,6 +93,7 @@ static const uint16_t LPUART_PRESCALER_TAB[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPUART_LL_ES_INIT LPUART Exported Init structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -140,10 +145,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup LPUART_LL_Exported_Constants LPUART Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPUART_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_LPUART_WriteReg function
* @{
*/
@@ -162,6 +169,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_LPUART_ReadReg function
* @{
*/
@@ -191,6 +199,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_LPUART_ReadReg and LL_LPUART_WriteReg functions
* @{
*/
@@ -212,6 +221,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_FIFOTHRESHOLD FIFO Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_FIFOTHRESHOLD_1_8 0x00000000U /*!< FIFO reaches 1/8 of its depth */
@@ -225,6 +235,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_DIRECTION Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_DIRECTION_NONE 0x00000000U /*!< Transmitter and Receiver are disabled */
@@ -236,6 +247,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_PARITY Parity Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_PARITY_NONE 0x00000000U /*!< Parity control disabled */
@@ -246,6 +258,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_WAKEUP Wakeup
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_WAKEUP_IDLELINE 0x00000000U /*!< LPUART wake up from Mute mode on Idle Line */
@@ -255,6 +268,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_DATAWIDTH Datawidth
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_DATAWIDTH_7B USART_CR1_M1 /*!< 7 bits word length : Start bit, 7 data bits, n stop bits */
@@ -265,6 +279,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_PRESCALER Clock Source Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_PRESCALER_DIV1 0x00000000U /*!< Input clock not devided */
@@ -284,6 +299,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_STOPBITS Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_STOPBITS_1 0x00000000U /*!< 1 stop bit */
@@ -293,6 +309,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_TXRX TX RX Pins Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_TXRX_STANDARD 0x00000000U /*!< TX/RX pins are used as defined in standard pinout */
@@ -302,6 +319,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_RXPIN_LEVEL RX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_RXPIN_LEVEL_STANDARD 0x00000000U /*!< RX pin signal works using the standard logic levels */
@@ -311,6 +329,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_TXPIN_LEVEL TX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_TXPIN_LEVEL_STANDARD 0x00000000U /*!< TX pin signal works using the standard logic levels */
@@ -320,6 +339,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_BINARY_LOGIC Binary Data Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_BINARY_LOGIC_POSITIVE 0x00000000U /*!< Logical data from the data register are send/received in positive/direct logic. (1=H, 0=L) */
@@ -329,6 +349,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_BITORDER Bit Order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_BITORDER_LSBFIRST 0x00000000U /*!< data is transmitted/received with data bit 0 first, following the start bit */
@@ -338,6 +359,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_ADDRESS_DETECT Address Length Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit address detection method selected */
@@ -347,6 +369,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_HWCONTROL Hardware Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_HWCONTROL_NONE 0x00000000U /*!< CTS and RTS hardware flow control disabled */
@@ -358,6 +381,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_WAKEUP_ON Wakeup Activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_WAKEUP_ON_ADDRESS 0x00000000U /*!< Wake up active on address match */
@@ -368,6 +392,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_DE_POLARITY Driver Enable Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_DE_POLARITY_HIGH 0x00000000U /*!< DE signal is active high */
@@ -377,6 +402,7 @@ typedef struct */
/** @defgroup LPUART_LL_EC_DMA_REG_DATA DMA Register Data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_LPUART_DMA_REG_DATA_TRANSMIT 0x00000000U /*!< Get address of data register used for transmission */
@@ -391,10 +417,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup LPUART_LL_Exported_Macros LPUART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPUART_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -419,6 +447,7 @@ typedef struct */
/** @defgroup LPUART_LL_EM_Exported_Macros_Helper Helper Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -455,10 +484,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup LPUART_LL_Exported_Functions LPUART Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LPUART_LL_EF_Configuration Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1395,6 +1426,7 @@ __STATIC_INLINE uint32_t LL_LPUART_GetBaudRate(USART_TypeDef *LPUARTx, uint32_t */
/** @defgroup LPUART_LL_EF_Configuration_HalfDuplex Configuration functions related to Half Duplex feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1436,6 +1468,7 @@ __STATIC_INLINE uint32_t LL_LPUART_IsEnabledHalfDuplex(USART_TypeDef *LPUARTx) */
/** @defgroup LPUART_LL_EF_Configuration_DE Configuration functions related to Driver Enable feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1550,6 +1583,7 @@ __STATIC_INLINE uint32_t LL_LPUART_GetDESignalPolarity(USART_TypeDef *LPUARTx) */
/** @defgroup LPUART_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1905,6 +1939,7 @@ __STATIC_INLINE void LL_LPUART_ClearFlag_WKUP(USART_TypeDef *LPUARTx) */
/** @defgroup LPUART_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2368,6 +2403,7 @@ __STATIC_INLINE uint32_t LL_LPUART_IsEnabledIT_RXFT(USART_TypeDef *LPUARTx) */
/** @defgroup LPUART_LL_EF_DMA_Management DMA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2503,6 +2539,7 @@ __STATIC_INLINE uint32_t LL_LPUART_DMA_GetRegAddr(USART_TypeDef *LPUARTx, uint32 */
/** @defgroup LPUART_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2557,6 +2594,7 @@ __STATIC_INLINE void LL_LPUART_TransmitData9(USART_TypeDef *LPUARTx, uint16_t Va */
/** @defgroup LPUART_LL_EF_Execution Execution
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2601,6 +2639,7 @@ __STATIC_INLINE void LL_LPUART_RequestRxDataFlush(USART_TypeDef *LPUARTx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup LPUART_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
ErrorStatus LL_LPUART_DeInit(USART_TypeDef *LPUARTx);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_mdma.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_mdma.h index a7d157ee25..2bd53a0c13 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_mdma.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_mdma.h @@ -35,12 +35,14 @@ extern "C" { #if defined (MDMA)
/** @defgroup MDMA_LL MDMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup MDMA_LL_Private_Variables MDMA Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Array used to get the MDMA channel register offset versus channel index LL_MDMA_CHANNEL_x */
@@ -70,6 +72,7 @@ static const uint32_t LL_MDMA_CH_OFFSET_TAB[] = /* Private constants ---------------------------------------------------------*/
/** @defgroup MDMA_LL_Private_Constants MDMA Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -81,6 +84,7 @@ static const uint32_t LL_MDMA_CH_OFFSET_TAB[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup MDMA_LL_ES_INIT MDMA Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -249,10 +253,12 @@ typedef struct #endif /*USE_FULL_LL_DRIVER*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup MDMA_LL_Exported_Constants MDMA Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDMA_LL_EC_CHANNEL CHANNEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_CHANNEL_0 0x00000000U
@@ -277,6 +283,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_WORD_ENDIANNESS Word Endianness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_WORD_ENDIANNESS_PRESERVE 0x00000000U /*!< Little endianess preserved for words */
@@ -287,6 +294,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_HALFWORD_ENDIANNESS Half Word Endianness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_HALFWORD_ENDIANNESS_PRESERVE 0x00000000U /*!< Little endianess preserved for half words */
@@ -297,6 +305,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_BYTE_ENDIANNESS Byte Endianness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_BYTE_ENDIANNESS_PRESERVE 0x00000000U /*!< Little endianess preserved for bytes */
@@ -307,6 +316,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_PRIORITY Transfer Priority level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_PRIORITY_LOW 0x00000000U /*!< Priority level : Low */
@@ -318,6 +328,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_BUFF_WRITE_MODE Bufferable Write Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_BUFF_WRITE_DISABLE 0x00000000U /*!< destination write operation is non-bufferable */
@@ -327,6 +338,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_REQUEST_MODE Request Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_REQUEST_MODE_HW 0x00000000U /*!< Request mode is Hardware */
@@ -336,6 +348,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_TRIGGER_MODE Trigger Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_BUFFER_TRANSFER 0x00000000U /*!< Each MDMA request (SW or HW) triggers a buffer transfer */
@@ -347,6 +360,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_PADDING_ALIGNMENT_MODE Padding Alignment Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DATAALIGN_RIGHT 0x00000000U /*!< Right Aligned, padded w/ 0s (default) */
@@ -358,6 +372,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_PACKING_MODE Transfer Packing
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_PACK_DISABLE 0x00000000U /*!< Packing disabled */
@@ -367,6 +382,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_DEST_BURST Transfer Destination Burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DEST_BURST_SINGLE 0x00000000U /*!< Single transfer */
@@ -382,6 +398,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_BURST Transfer Source Burst
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_SRC_BURST_SINGLE 0x00000000U /*!< Single transfer */
@@ -397,6 +414,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_DEST_INC_OFFSET_SIZE Destination Increment Offset Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DEST_INC_OFFSET_BYTE 0x00000000U /*!< offset is Byte (8-bit) */
@@ -408,6 +426,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_INC_OFFSET_SIZE Source Increment Offset Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_SRC_INC_OFFSET_BYTE 0x00000000U /*!< offset is Byte (8-bit) */
@@ -419,6 +438,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_DEST_DATA_SIZE Destination Data Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DEST_DATA_SIZE_BYTE 0x00000000U /*!< Destination data size is Byte */
@@ -430,6 +450,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_DATA_SIZE Source Data Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_SRC_DATA_SIZE_BYTE 0x00000000U /*!< Source data size is Byte */
@@ -441,6 +462,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_DEST_INC_MODE Destination Increment Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DEST_FIXED 0x00000000U /*!< Destination address pointer is fixed */
@@ -451,6 +473,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_INC_MODE Source Increment Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_SRC_FIXED 0x00000000U /*!< Destination address pointer is fixed */
@@ -461,6 +484,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_BLK_RPT_DEST_ADDR_UPDATE_MODE Block Repeat Destination address Update Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_BLK_RPT_DEST_ADDR_INCREMENT 0x00000000U /*!< Destination address pointer is incremented after each block transfer by Destination Update Value */
@@ -470,6 +494,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_BLK_RPT_ADDR_UPDATE_MODE Source Block Repeat address Update Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_BLK_RPT_SRC_ADDR_INCREMENT 0x00000000U /*!< Source address pointer is incremented after each block transfer by Source Update Value */
@@ -479,6 +504,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_DEST_BUS Destination BUS Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_DEST_BUS_SYSTEM_AXI 0x00000000U /*!< System/AXI bus is used as destination */
@@ -488,6 +514,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_SRC_BUS Source BUS Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_SRC_BUS_SYSTEM_AXI 0x00000000U /*!< System/AXI bus is used as source */
@@ -497,6 +524,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_HW_TRIGGER_SELCTION HW Trigger Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_REQ_DMA1_STREAM0_TC 0x00000000U /*!< MDMA HW Trigger (request) is DMA1 Stream 0 Transfer Complete Flag */
@@ -552,6 +580,7 @@ typedef struct */
/** @defgroup MDMA_LL_EC_XFER_ERROR_DIRECTION Transfer Error Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_MDMA_READ_ERROR 0x00000000U /*!< Last transfer error on the channel was a related to a read access */
@@ -566,10 +595,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup MDMA_LL_Exported_Macros MDMA Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDMA_LL_EM_WRITE_READ Common Write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -593,6 +624,7 @@ typedef struct */
/** @defgroup MDMA_LL_EM_CONVERT_DMAxCHANNELy Convert MDMAxChannely
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -660,10 +692,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup MDMA_LL_Exported_Functions MDMA Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup MDMA_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3377,6 +3411,7 @@ __STATIC_INLINE uint32_t LL_MDMA_GetXferErrorLSBAddress(MDMA_TypeDef *MDMAx, uin */
/** @defgroup MDMA_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3863,6 +3898,7 @@ __STATIC_INLINE void LL_MDMA_ClearFlag_TC(MDMA_TypeDef *MDMAx, uint32_t Channel) */
/** @defgroup MDMA_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4322,6 +4358,7 @@ __STATIC_INLINE uint32_t LL_MDMA_IsEnabledIT_TC(MDMA_TypeDef *MDMAx, uint32_t Ch #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup MDMA_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_opamp.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_opamp.h index c8ccd2bbe1..89c76c8d42 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_opamp.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_opamp.h @@ -35,6 +35,7 @@ extern "C" { #if defined (OPAMP1) || defined (OPAMP2)
/** @defgroup OPAMP_LL OPAMP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup OPAMP_LL_Private_Constants OPAMP Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -74,6 +76,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup OPAMP_LL_Private_Macros OPAMP Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -98,6 +101,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup OPAMP_LL_ES_INIT OPAMP Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -138,10 +142,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup OPAMP_LL_Exported_Constants OPAMP Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMP_LL_EC_MODE OPAMP mode calibration or functional.
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_MODE_FUNCTIONAL 0x00000000U /*!< OPAMP functional mode */
@@ -151,6 +157,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_FUNCTIONAL_MODE OPAMP functional mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_MODE_STANDALONE 0x00000000U /*!< OPAMP functional mode, OPAMP operation in standalone */
@@ -170,6 +177,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_MODE_PGA_GAIN OPAMP PGA gain (relevant when OPAMP is in functional mode PGA)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note Gain sign:
* - is positive if the @ref OPAMP_LL_EC_FUNCTIONAL_MODE configuration is
* @ref LL_OPAMP_MODE_PGA or LL_OPAMP_MODE_PGA_IO0
@@ -187,6 +195,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_INPUT_NONINVERTING OPAMP input non-inverting
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_INPUT_NONINVERT_IO0 0x00000000U /*!< OPAMP non inverting input connected to I/O VINP0
@@ -205,6 +214,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_INPUT_INVERTING OPAMP input inverting
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note OPAMP inverting input is used with OPAMP in mode standalone or PGA with negative gain or bias.
* Otherwise (OPAMP in mode follower), OPAMP inverting input is not used (not connected to GPIO pin).
* @{
@@ -224,6 +234,7 @@ typedef struct /** @defgroup OPAMP_LL_EC_POWER_MODE OPAMP PowerMode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_POWERMODE_NORMAL (OPAMP_POWERMODE_OTR_REGOFFSET) /*!< OPAMP output in normal mode */
@@ -233,6 +244,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_TRIMMING_MODE OPAMP trimming mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_TRIMMING_FACTORY 0x00000000U /*!< OPAMP trimming factors set to factory values */
@@ -242,6 +254,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_TRIMMING_TRANSISTORS_DIFF_PAIR OPAMP trimming of transistors differential pair NMOS or PMOS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_OPAMP_TRIMMING_NMOS_VREF_90PC_VDDA (OPAMP_OTR_TRIMOFFSETN | ((OPAMP_CSR_CALSEL_1 | OPAMP_CSR_CALSEL_0) << 4)) /*!< OPAMP trimming of transistors differential pair NMOS (internal reference voltage set to 0.9*Vdda). Default parameters to be used for calibration using two trimming steps (one with each transistors differential pair NMOS and PMOS). */
@@ -255,6 +268,7 @@ typedef struct */
/** @defgroup OPAMP_LL_EC_HW_DELAYS Definitions of OPAMP hardware constraints delays
+ * @ingroup RTEMSBSPsARMSTM32H7 * @note Only OPAMP IP HW delays are defined in OPAMP LL driver driver,
* not timeout values.
* For details on delays values, refer to descriptions in source code
@@ -282,9 +296,11 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup OPAMP_LL_Exported_Macros OPAMP Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMP_LL_EM_WRITE_READ Common write and read registers macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -307,6 +323,7 @@ typedef struct * @}
*/
/** @defgroup OPAMP_LL_EM_HELPER_MACRO OPAMP helper macro
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -352,10 +369,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup OPAMP_LL_Exported_Functions OPAMP Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup OPAMP_LL_EF_CONFIGURATION_OPAMP_INSTANCE Configuration of OPAMP hierarchical scope: OPAMP instance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -510,6 +529,7 @@ __STATIC_INLINE uint32_t LL_OPAMP_GetPowerMode(OPAMP_TypeDef *OPAMPx) */
/** @defgroup OPAMP_LL_EF_CONFIGURATION_INPUTS Configuration of OPAMP inputs
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -587,6 +607,7 @@ __STATIC_INLINE uint32_t LL_OPAMP_GetInputInverting(OPAMP_TypeDef *OPAMPx) */
/** @defgroup OPAMP_LL_EF_OPAMP_TRIMMING Configuration and operation of OPAMP trimming
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -746,6 +767,7 @@ __STATIC_INLINE uint32_t LL_OPAMP_GetTrimmingValue(OPAMP_TypeDef* OPAMPx, uint32 */
/** @defgroup OPAMP_LL_EF_OPERATION Operation on OPAMP instance
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -790,6 +812,7 @@ __STATIC_INLINE uint32_t LL_OPAMP_IsEnabled(OPAMP_TypeDef *OPAMPx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup OPAMP_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_pwr.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_pwr.h index 1916958450..8d78afa492 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_pwr.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_pwr.h @@ -35,6 +35,7 @@ extern "C" { #if defined (PWR)
/** @defgroup PWR_LL PWR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -42,10 +43,12 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup PWR_LL_Private_Constants PWR Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_LL_WAKEUP_PIN_OFFSET Wake-Up Pins register offsets Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_PWR_WriteReg function
* @{
*/
@@ -62,10 +65,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup PWR_LL_Exported_Constants PWR Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_PWR_WriteReg function
* @{
*/
@@ -84,6 +89,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_PWR_ReadReg function
* @{
*/
@@ -141,6 +147,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_MODE_PWR Power mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (PWR_CPUCR_PDDS_D2)
@@ -180,6 +187,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_REGU_VOLTAGE Run mode Regulator Voltage Scaling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (PWR_CPUCR_PDDS_D2)
@@ -198,6 +206,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_STOP_MODE_REGU_VOLTAGE Stop mode Regulator Voltage Scaling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_REGU_VOLTAGE_SVOS_SCALE5 PWR_CR1_SVOS_0 /*!< Select voltage scale 5 when system enters STOP mode */
@@ -208,6 +217,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_REGU_MODE_DS_MODE Regulator Mode In Deep Sleep Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_REGU_DSMODE_MAIN 0x00000000U /*!< Voltage Regulator in main mode during deepsleep mode */
@@ -217,6 +227,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_PVDLEVEL Power Digital Voltage Level Detector
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_PVDLEVEL_0 PWR_CR1_PLS_LEV0 /*!< Voltage threshold detected by PVD 1.95 V */
@@ -232,6 +243,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_AVDLEVEL Power Analog Voltage Level Detector
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_AVDLEVEL_0 PWR_CR1_ALS_LEV0 /*!< Analog Voltage threshold detected by AVD 1.7 V */
@@ -244,6 +256,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_BATT_CHARG_RESISTOR Battery Charge Resistor
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_BATT_CHARG_RESISTOR_5K 0x00000000U /*!< Charge the Battery through a 5 kO resistor */
@@ -253,6 +266,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_WAKEUP_PIN Wakeup Pins
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_WAKEUP_PIN1 PWR_WKUPEPR_WKUPEN1 /*!< Wake-Up pin 1 : PA0 */
@@ -266,6 +280,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_WAKEUP_PIN_PULL Wakeup Pins pull configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_WAKEUP_PIN_NOPULL 0x00000000UL /*!< Configure Wake-Up pin in no pull */
@@ -276,6 +291,7 @@ extern "C" { */
/** @defgroup PWR_LL_EC_SUPPLY_PWR Power supply source configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_PWR_LDO_SUPPLY PWR_CR3_LDOEN /*!< Core domains are suppplied from the LDO */
@@ -298,10 +314,12 @@ extern "C" { */
/* Exported macro ------------------------------------------------------------*/
/** @defgroup PWR_LL_Exported_Macros PWR Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_LL_EM_WRITE_READ Common write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -328,10 +346,12 @@ extern "C" { */
/* Exported functions --------------------------------------------------------*/
/** @defgroup PWR_LL_Exported_Functions PWR Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup PWR_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1822,6 +1842,7 @@ __STATIC_INLINE uint32_t LL_PWR_GetWakeUpPinPull(uint32_t WakeUpPin) */
/** @defgroup PWR_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2213,6 +2234,7 @@ __STATIC_INLINE void LL_PWR_ClearFlag_WU1(void) #if defined (USE_FULL_LL_DRIVER)
/** @defgroup PWR_LL_EF_Init De-initialization function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
ErrorStatus LL_PWR_DeInit(void);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_rcc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_rcc.h index c0c65ad82b..8d8c794b85 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_rcc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_rcc.h @@ -38,12 +38,14 @@ extern "C" { #if defined(RCC)
/** @defgroup RCC_LL RCC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup RCC_LL_Private_Variables RCC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
extern const uint8_t LL_RCC_PrescTable[16];
@@ -97,6 +99,7 @@ extern const uint8_t LL_RCC_PrescTable[16]; #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RCC_LL_Private_Macros RCC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -106,10 +109,12 @@ extern const uint8_t LL_RCC_PrescTable[16]; /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RCC_LL_Exported_Types RCC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup LL_ES_CLOCK_FREQ Clocks Frequency Structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -149,10 +154,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RCC_LL_Exported_Constants RCC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCC_LL_EC_OSC_VALUES Oscillator Values adaptation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Defines used to adapt values of different oscillators
* @note These values could be modified in the user environment according to
* HW set-up.
@@ -195,6 +202,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_HSIDIV HSI oscillator divider
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_HSI_DIV1 RCC_CR_HSIDIV_1
@@ -206,6 +214,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_LSEDRIVE LSE oscillator drive capability
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_LSEDRIVE_LOW (uint32_t)(0x00000000U)
@@ -217,6 +226,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SYS_CLKSOURCE System clock switch
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_SYS_CLKSOURCE_HSI RCC_CFGR_SW_HSI
@@ -228,6 +238,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SYS_CLKSOURCE_STATUS System clock switch status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_SYS_CLKSOURCE_STATUS_HSI RCC_CFGR_SWS_HSI /*!< HSI used as system clock */
@@ -239,6 +250,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SYSWAKEUP_CLKSOURCE System wakeup clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_SYSWAKEUP_CLKSOURCE_HSI (uint32_t)(0x00000000U)
@@ -248,6 +260,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_KERWAKEUP_CLKSOURCE Kernel wakeup clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_KERWAKEUP_CLKSOURCE_HSI (uint32_t)(0x00000000U)
@@ -257,6 +270,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SYSCLK_DIV System prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CFGR_D1CPRE_DIV1)
@@ -285,6 +299,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_AHB_DIV AHB prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CFGR_HPRE_DIV1)
@@ -313,6 +328,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_APB1_DIV APB low-speed prescaler (APB1)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CFGR_D2PPRE1_DIV1)
@@ -333,6 +349,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_APB2_DIV APB low-speed prescaler (APB2)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CFGR_D2PPRE2_DIV1)
@@ -353,6 +370,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_APB3_DIV APB low-speed prescaler (APB3)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CFGR_D1PPRE_DIV1)
@@ -373,6 +391,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_APB4_DIV APB low-speed prescaler (APB4)
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CFGR_D3PPRE_DIV1)
@@ -393,6 +412,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_MCOxSOURCE MCO source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_MCO1SOURCE_HSI (uint32_t)((RCC_CFGR_MCO1>>16U) | 0x00000000U)
@@ -411,6 +431,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_MCOx_DIV MCO prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_MCO1_DIV_1 (uint32_t)((RCC_CFGR_MCO1PRE>>16U) | RCC_CFGR_MCO1PRE_0)
@@ -449,6 +470,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_RTC_HSEDIV HSE prescaler for RTC clock
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_RTC_NOCLOCK (uint32_t)(0x00000000U)
@@ -519,6 +541,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_USARTx_CLKSOURCE Peripheral USART clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_USART16SEL)
@@ -563,6 +586,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_LPUARTx_CLKSOURCE Peripheral LPUART clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_LPUART1SEL)
@@ -585,6 +609,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_I2Cx_CLKSOURCE Peripheral I2C clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (RCC_D2CCIP2R_I2C123SEL)
@@ -614,6 +639,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_LPTIMx_CLKSOURCE Peripheral LPTIM clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_LPTIM1SEL)
@@ -673,6 +699,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SAIx_CLKSOURCE Peripheral SAI clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SAI1SEL)
@@ -730,6 +757,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SDMMC_CLKSOURCE Peripheral SDMMC clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_SDMMCSEL)
@@ -744,6 +772,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_RNG_CLKSOURCE Peripheral RNG clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_RNGSEL)
@@ -762,6 +791,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_USB_CLKSOURCE Peripheral USB clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_USBSEL)
@@ -780,6 +810,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_CEC_CLKSOURCE Peripheral CEC clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_CECSEL)
@@ -797,6 +828,7 @@ typedef struct #if defined(DSI)
/** @defgroup RCC_LL_EC_DSI_CLKSOURCE Peripheral DSI clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_DSI_CLKSOURCE_PHY (0x00000000U)
@@ -807,6 +839,7 @@ typedef struct #endif /* DSI */
/** @defgroup RCC_LL_EC_DFSDM_CLKSOURCE Peripheral DFSDM clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_DFSDM1SEL)
@@ -822,6 +855,7 @@ typedef struct #if defined(DFSDM2_BASE)
/** @defgroup RCC_LL_EC_DFSDM2_CLKSOURCE Peripheral DFSDM2 clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_DFSDM2_CLKSOURCE_PCLK4 (0x00000000U)
@@ -832,6 +866,7 @@ typedef struct #endif /* DFSDM2_BASE */
/** @defgroup RCC_LL_EC_FMC_CLKSOURCE Peripheral FMC clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_FMCSEL)
@@ -851,6 +886,7 @@ typedef struct #if defined(QUADSPI)
/** @defgroup RCC_LL_EC_QSPI_CLKSOURCE Peripheral QSPI clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_QSPI_CLKSOURCE_HCLK (0x00000000U)
@@ -865,6 +901,7 @@ typedef struct #if defined(OCTOSPI1) || defined(OCTOSPI2)
/** @defgroup RCC_LL_EC_OSPI_CLKSOURCE Peripheral OSPI clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_OSPI_CLKSOURCE_HCLK (0x00000000U)
@@ -878,6 +915,7 @@ typedef struct /** @defgroup RCC_LL_EC_CLKP_CLKSOURCE Peripheral CLKP clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_CKPERSEL)
@@ -894,6 +932,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SPIx_CLKSOURCE Peripheral SPI clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPI123SEL)
@@ -945,6 +984,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SPDIF_CLKSOURCE Peripheral SPDIF clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPDIFSEL)
@@ -964,6 +1004,7 @@ typedef struct #if defined(FDCAN1) || defined(FDCAN2)
/** @defgroup RCC_LL_EC_FDCAN_CLKSOURCE Peripheral FDCAN clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_FDCANSEL)
@@ -981,6 +1022,7 @@ typedef struct #endif /*FDCAN1 || FDCAN2*/
/** @defgroup RCC_LL_EC_SWP_CLKSOURCE Peripheral SWP clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SWPSEL)
@@ -995,6 +1037,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_ADC_CLKSOURCE Peripheral ADC clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_ADCSEL)
@@ -1011,6 +1054,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_USARTx_CLKSOURCE Peripheral USART get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (RCC_D2CCIP2R_USART16SEL)
@@ -1030,6 +1074,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_LPUARTx_CLKSOURCE Peripheral LPUART get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_LPUART1SEL)
@@ -1042,6 +1087,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_I2Cx_CLKSOURCE Peripheral I2C get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_I2C123SEL)
@@ -1059,6 +1105,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_LPTIMx_CLKSOURCE Peripheral LPTIM get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP2R_LPTIM1SEL)
@@ -1082,6 +1129,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SAIx_CLKSOURCE Peripheral SAI get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SAI1SEL)
@@ -1109,6 +1157,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SDMMC_CLKSOURCE Peripheral SDMMC get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_SDMMCSEL)
@@ -1121,6 +1170,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_RNG_CLKSOURCE Peripheral RNG get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (RCC_D2CCIP2R_RNGSEL)
@@ -1133,6 +1183,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_USB_CLKSOURCE Peripheral USB get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (RCC_D2CCIP2R_USBSEL)
@@ -1145,6 +1196,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_CEC_CLKSOURCE Peripheral CEC get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if (RCC_D2CCIP2R_CECSEL)
@@ -1158,6 +1210,7 @@ typedef struct #if defined(DSI)
/** @defgroup RCC_LL_EC_DSI_CLKSOURCE Peripheral DSI get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_DSI_CLKSOURCE RCC_D1CCIPR_DSISEL
@@ -1167,6 +1220,7 @@ typedef struct #endif /* DSI */
/** @defgroup RCC_LL_EC_DFSDM_CLKSOURCE Peripheral DFSDM get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_DFSDM1SEL)
@@ -1180,6 +1234,7 @@ typedef struct #if defined(DFSDM2_BASE)
/** @defgroup RCC_LL_EC_DFSDM2_CLKSOURCE Peripheral DFSDM2 get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_DFSDM2_CLKSOURCE RCC_SRDCCIPR_DFSDM2SEL
@@ -1190,6 +1245,7 @@ typedef struct /** @defgroup RCC_LL_EC_FMC_CLKSOURCE Peripheral FMC get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_FMCSEL)
@@ -1203,6 +1259,7 @@ typedef struct #if defined(QUADSPI)
/** @defgroup RCC_LL_EC_QSPI_CLKSOURCE Peripheral QSPI get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_QSPI_CLKSOURCE RCC_D1CCIPR_QSPISEL
@@ -1213,6 +1270,7 @@ typedef struct #if defined(OCTOSPI1) || defined(OCTOSPI2)
/** @defgroup RCC_LL_EC_OSPI_CLKSOURCE Peripheral OSPI get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_OSPI_CLKSOURCE RCC_CDCCIPR_OCTOSPISEL
@@ -1222,6 +1280,7 @@ typedef struct #endif /* OCTOSPI1 || OCTOSPI2 */
/** @defgroup RCC_LL_EC_CLKP_CLKSOURCE Peripheral CLKP get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D1CCIPR_CKPERSEL)
@@ -1234,6 +1293,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SPIx_CLKSOURCE Peripheral SPI get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPI123SEL)
@@ -1256,6 +1316,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_SPDIF_CLKSOURCE Peripheral SPDIF get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SPDIFSEL)
@@ -1269,6 +1330,7 @@ typedef struct #if defined(FDCAN1) || defined(FDCAN2)
/** @defgroup RCC_LL_EC_FDCAN_CLKSOURCE Peripheral FDCAN get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_FDCANSEL)
@@ -1282,6 +1344,7 @@ typedef struct #endif /*FDCAN1 || FDCAN2*/
/** @defgroup RCC_LL_EC_SWP_CLKSOURCE Peripheral SWP get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D2CCIP1R_SWPSEL)
@@ -1294,6 +1357,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_ADC_CLKSOURCE Peripheral ADC get clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_D3CCIPR_ADCSEL)
@@ -1306,6 +1370,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_RTC_CLKSOURCE RTC clock source selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_RTC_CLKSOURCE_NONE (uint32_t)(0x00000000U)
@@ -1317,6 +1382,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_TIM_CLKPRESCALER Timers clocks prescalers selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_TIM_PRESCALER_TWICE (uint32_t)(0x00000000U)
@@ -1327,6 +1393,7 @@ typedef struct #if defined(HRTIM1)
/** @defgroup RCC_LL_EC_HRTIM_CLKSOURCE High Resolution Timers clock selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_HRTIM_CLKSOURCE_TIM (uint32_t)(0x00000000U) /* HRTIM Clock source is same as other timers */
@@ -1337,6 +1404,7 @@ typedef struct #endif /* HRTIM1 */
/** @defgroup RCC_LL_EC_PLLSOURCE All PLLs entry clock source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_PLLSOURCE_HSI RCC_PLLCKSELR_PLLSRC_HSI
@@ -1348,6 +1416,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_PLLINPUTRANGE All PLLs input range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_PLLINPUTRANGE_1_2 (uint32_t)(0x00000000U)
@@ -1359,6 +1428,7 @@ typedef struct */
/** @defgroup RCC_LL_EC_PLLVCORANGE All PLLs VCO range
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_PLLVCORANGE_WIDE (uint32_t)(0x00000000U) /* VCO output range: 192 to 836 MHz OR 128 to 544 MHz (*) */
@@ -1374,10 +1444,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup RCC_LL_Exported_Macros RCC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCC_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1400,6 +1472,7 @@ typedef struct */
/** @defgroup RCC_LL_EM_CALC_FREQ Calculate frequencies
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1519,6 +1592,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RCC_LL_EC_PERIPH_FREQUENCY Peripheral clock frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RCC_PERIPH_FREQUENCY_NO 0x00000000U /*!< No clock enabled for the peripheral */
@@ -1534,10 +1608,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RCC_LL_Exported_Functions RCC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RCC_LL_EF_HSE HSE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1630,6 +1706,7 @@ __STATIC_INLINE uint32_t LL_RCC_HSE_IsReady(void) */
/** @defgroup RCC_LL_EF_HSI HSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1789,6 +1866,7 @@ __STATIC_INLINE uint32_t LL_RCC_HSI_GetCalibTrimming(void) */
/** @defgroup RCC_LL_EF_CSI CSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1922,6 +2000,7 @@ __STATIC_INLINE uint32_t LL_RCC_CSI_GetCalibTrimming(void) */
/** @defgroup RCC_LL_EF_HSI48 HSI48
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1973,6 +2052,7 @@ __STATIC_INLINE uint32_t LL_RCC_HSI48_GetCalibration(void) #if defined(RCC_CR_D1CKRDY)
/** @defgroup RCC_LL_EF_D1CLK D1CKREADY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1992,6 +2072,7 @@ __STATIC_INLINE uint32_t LL_RCC_D1CK_IsReady(void) #else
/** @defgroup RCC_LL_EF_CPUCLK CPUCKREADY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2014,6 +2095,7 @@ __STATIC_INLINE uint32_t LL_RCC_CPUCK_IsReady(void) #if defined(RCC_CR_D2CKRDY)
/** @defgroup RCC_LL_EF_D2CLK D2CKREADY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2032,6 +2114,7 @@ __STATIC_INLINE uint32_t LL_RCC_D2CK_IsReady(void) #else
/** @defgroup RCC_LL_EF_CDCLK CDCKREADY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2051,6 +2134,7 @@ __STATIC_INLINE uint32_t LL_RCC_CDCK_IsReady(void) #endif /* RCC_CR_D2CKRDY */
/** @defgroup RCC_LL_EF_SYSTEM_WIDE_RESET RESET
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RCC_GCR_WW1RSC)
@@ -2103,6 +2187,7 @@ __STATIC_INLINE uint32_t LL_RCC_WWDG2_IsSystemReset(void) #if defined(DUAL_CORE)
/** @defgroup RCC_LL_EF_BOOT_CPU CPU
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2152,6 +2237,7 @@ __STATIC_INLINE uint32_t LL_RCC_IsCM7BootForced(void) #endif /*DUAL_CORE*/
/** @defgroup RCC_LL_EF_LSE LSE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2288,6 +2374,7 @@ __STATIC_INLINE uint32_t LL_RCC_LSE_IsReady(void) */
/** @defgroup RCC_LL_EF_LSI LSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2326,6 +2413,7 @@ __STATIC_INLINE uint32_t LL_RCC_LSI_IsReady(void) */
/** @defgroup RCC_LL_EF_System System
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2663,6 +2751,7 @@ __STATIC_INLINE uint32_t LL_RCC_GetAPB4Prescaler(void) */
/** @defgroup RCC_LL_EF_MCO MCO
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2727,6 +2816,7 @@ __STATIC_INLINE void LL_RCC_ConfigMCO(uint32_t MCOxSource, uint32_t MCOxPrescale */
/** @defgroup RCC_LL_EF_Peripheral_Clock_Source Peripheral Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3894,6 +3984,7 @@ __STATIC_INLINE uint32_t LL_RCC_GetADCClockSource(uint32_t Periph) */
/** @defgroup RCC_LL_EF_RTC RTC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4135,6 +4226,7 @@ __STATIC_INLINE uint32_t LL_RCC_GetRTC_HSEPrescaler(void) */
/** @defgroup RCC_LL_EF_TIM_CLOCK_PRESCALER TIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4169,6 +4261,7 @@ __STATIC_INLINE uint32_t LL_RCC_GetTIMPrescaler(void) #if defined(HRTIM1)
/** @defgroup RCC_LL_EF_HRTIM_SET_CLOCK_SOURCE HRTIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4204,6 +4297,7 @@ __STATIC_INLINE uint32_t LL_RCC_GetHRTIMClockSource(void) #endif /* HRTIM1 */
/** @defgroup RCC_LL_EF_PLL PLL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5180,6 +5274,7 @@ __STATIC_INLINE void LL_RCC_PLL3_SetFRACN(uint32_t FRACN) /** @defgroup RCC_LL_EF_FLAG_Management FLAG Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5942,6 +6037,7 @@ __STATIC_INLINE void LL_C2_RCC_ClearResetFlags(void) */
/** @defgroup RCC_LL_EF_IT_Management IT Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -6250,6 +6346,7 @@ __STATIC_INLINE uint32_t LL_RCC_IsEnableIT_LSECSS(void) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RCC_LL_EF_Init De-initialization function
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
void LL_RCC_DeInit(void);
@@ -6258,6 +6355,7 @@ void LL_RCC_DeInit(void); */
/** @defgroup RCC_LL_EF_Get_Freq Get system and peripherals clocks frequency functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
uint32_t LL_RCC_CalcPLLClockFreq(uint32_t PLLInputFreq, uint32_t M, uint32_t N, uint32_t FRACN, uint32_t PQR);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_rng.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_rng.h index e8ddb5c407..5279603d32 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_rng.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_rng.h @@ -35,6 +35,7 @@ extern "C" { #if defined (RNG)
/** @defgroup RNG_LL RNG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -46,6 +47,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RNG_LL_ES_Init_Struct RNG Exported Init structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -67,10 +69,12 @@ typedef struct #endif /* USE_FULL_LL_DRIVER */
/* Exported constants --------------------------------------------------------*/
/** @defgroup RNG_LL_Exported_Constants RNG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_LL_CED Clock Error Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RNG_CED_ENABLE 0x00000000U /*!< Clock error detection enabled */
@@ -81,6 +85,7 @@ typedef struct #if defined(RNG_CR_CONDRST)
/** @defgroup RNG_LL_Clock_Divider_Factor Value used to configure an internal
+ * @ingroup RTEMSBSPsARMSTM32H7 * programmable divider acting on the incoming RNG clock
* @{
*/
@@ -105,6 +110,7 @@ typedef struct */
/** @defgroup RNG_LL_NIST_Compliance NIST Compliance configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RNG_NIST_COMPLIANT (0x00000000UL) /*!< Default NIST compliant configuration*/
@@ -116,6 +122,7 @@ typedef struct #endif/*RNG_CR_CONDRST*/
/** @defgroup RNG_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_RNG_ReadReg function
* @{
*/
@@ -129,6 +136,7 @@ typedef struct */
/** @defgroup RNG_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_RNG_ReadReg and LL_RNG_WriteReg macros
* @{
*/
@@ -143,10 +151,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup RNG_LL_Exported_Macros RNG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -177,9 +187,11 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RNG_LL_Exported_Functions RNG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RNG_LL_EF_Configuration RNG Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -467,6 +479,7 @@ __STATIC_INLINE uint32_t LL_RNG_GetClockDivider(RNG_TypeDef *RNGx) */
/** @defgroup RNG_LL_EF_FLAG_Management FLAG Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -552,6 +565,7 @@ __STATIC_INLINE void LL_RNG_ClearFlag_SEIS(RNG_TypeDef *RNGx) */
/** @defgroup RNG_LL_EF_IT_Management IT Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -596,6 +610,7 @@ __STATIC_INLINE uint32_t LL_RNG_IsEnabledIT(RNG_TypeDef *RNGx) */
/** @defgroup RNG_LL_EF_Data_Management Data Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -616,6 +631,7 @@ __STATIC_INLINE uint32_t LL_RNG_ReadRandData32(RNG_TypeDef *RNGx) #if defined (RNG_VER_3_1)
/** @defgroup RNG_LL_EF_Health_Test_Control Health Test Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -648,6 +664,7 @@ __STATIC_INLINE uint32_t LL_RNG_GetHealthConfig(RNG_TypeDef *RNGx) #endif /*RNG_VER_3_1*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RNG_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
ErrorStatus LL_RNG_Init(RNG_TypeDef *RNGx, LL_RNG_InitTypeDef *RNG_InitStruct);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_rtc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_rtc.h index 142c75a874..943ba4ff01 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_rtc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_rtc.h @@ -35,6 +35,7 @@ extern "C" { #if defined(RTC)
/** @defgroup RTC_LL RTC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -42,6 +43,7 @@ extern "C" { /* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RTC_LL_Private_Constants RTC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Masks Definition */
@@ -67,6 +69,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RTC_LL_Private_Macros RTC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -77,6 +80,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RTC_LL_ES_INIT RTC Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -198,11 +202,13 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup RTC_LL_Exported_Constants RTC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RTC_LL_EC_FORMAT FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_FORMAT_BIN 0x00000000U /*!< Binary data format */
@@ -212,6 +218,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMA_WEEKDAY_SELECTION RTC Alarm A Date WeekDay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMA_DATEWEEKDAYSEL_DATE 0x00000000U /*!< Alarm A Date is selected */
@@ -221,6 +228,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMB_WEEKDAY_SELECTION RTC Alarm B Date WeekDay
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMB_DATEWEEKDAYSEL_DATE 0x00000000U /*!< Alarm B Date is selected */
@@ -232,6 +240,7 @@ typedef struct #endif /* USE_FULL_LL_DRIVER */
/** @defgroup RTC_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_RTC_ReadReg function
* @{
*/
@@ -276,6 +285,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_RTC_ReadReg and LL_RTC_WriteReg functions
* @{
*/
@@ -300,6 +310,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_WEEKDAY WEEK DAY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_WEEKDAY_MONDAY (uint8_t)0x01 /*!< Monday */
@@ -314,6 +325,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_MONTH MONTH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_MONTH_JANUARY (uint8_t)0x01 /*!< January */
@@ -333,6 +345,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_HOURFORMAT HOUR FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_HOURFORMAT_24HOUR 0x00000000U /*!< 24 hour/day format */
@@ -342,6 +355,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALARMOUT ALARM OUTPUT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALARMOUT_DISABLE 0x00000000U /*!< Output disabled */
@@ -353,6 +367,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALARM_OUTPUTTYPE ALARM OUTPUT TYPE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(RTC_CR_TAMPALRM_TYPE)
@@ -368,6 +383,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_OUTPUTPOLARITY_PIN OUTPUT POLARITY PIN
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_OUTPUTPOLARITY_PIN_HIGH 0x00000000U /*!< Pin is high when ALRAF/ALRBF/WUTF is asserted (depending on OSEL)*/
@@ -377,6 +393,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_TIME_FORMAT TIME FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TIME_FORMAT_AM_OR_24 0x00000000U /*!< AM or 24-hour format */
@@ -386,6 +403,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_SHIFT_SECOND SHIFT SECOND
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_SHIFT_SECOND_DELAY 0x00000000U /* Delay (seconds) = SUBFS / (PREDIV_S + 1) */
@@ -395,6 +413,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMA_MASK ALARMA MASK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMA_MASK_NONE 0x00000000U /*!< No masks applied on Alarm A*/
@@ -408,6 +427,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMA_TIME_FORMAT ALARMA TIME FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMA_TIME_FORMAT_AM 0x00000000U /*!< AM or 24-hour format */
@@ -417,6 +437,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMB_MASK ALARMB MASK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMB_MASK_NONE 0x00000000U /*!< No masks applied on Alarm B*/
@@ -430,6 +451,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_ALMB_TIME_FORMAT ALARMB TIME FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_ALMB_TIME_FORMAT_AM 0x00000000U /*!< AM or 24-hour format */
@@ -439,6 +461,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_TIMESTAMP_EDGE TIMESTAMP EDGE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TIMESTAMP_EDGE_RISING 0x00000000U /*!< RTC_TS input rising edge generates a time-stamp event */
@@ -448,6 +471,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_TS_TIME_FORMAT TIMESTAMP TIME FORMAT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TS_TIME_FORMAT_AM 0x00000000U /*!< AM or 24-hour format */
@@ -458,6 +482,7 @@ typedef struct #if defined(TAMP_CR1_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER TAMPER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_1 TAMP_CR1_TAMP1E /*!< Tamper 1 input detection */
@@ -474,6 +499,7 @@ typedef struct #if defined(TAMP_CR1_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_MASK TAMPER MASK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_MASK_TAMPER1 TAMP_CR2_TAMP1MSK /*!< Tamper 1 event generates a trigger event. TAMP1F is masked and internally cleared by hardware. The backup registers are not erased */
@@ -490,6 +516,7 @@ typedef struct #if defined(TAMP_CR1_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_NOERASE TAMPER NO ERASE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_NOERASE_TAMPER1 TAMP_CR2_TAMP1NOERASE /*!< Tamper 1 event does not erase the backup registers. */
@@ -506,6 +533,7 @@ typedef struct #if defined(TAMP_FLTCR_TAMPPRCH)
/** @defgroup RTC_LL_EC_TAMPER_DURATION TAMPER DURATION
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_DURATION_1RTCCLK 0x00000000U /*!< Tamper pins are pre-charged before sampling during 1 RTCCLK cycle */
@@ -519,6 +547,7 @@ typedef struct #if defined(TAMP_FLTCR_TAMPFLT)
/** @defgroup RTC_LL_EC_TAMPER_FILTER TAMPER FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_FILTER_DISABLE 0x00000000U /*!< Tamper filter is disabled */
@@ -532,6 +561,7 @@ typedef struct #if defined(TAMP_FLTCR_TAMPFREQ)
/** @defgroup RTC_LL_EC_TAMPER_SAMPLFREQDIV TAMPER SAMPLING FREQUENCY DIVIDER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_SAMPLFREQDIV_32768 0x00000000U /*!< Each of the tamper inputs are sampled with a frequency = RTCCLK / 32768 */
@@ -549,6 +579,7 @@ typedef struct #if defined(TAMP_CR1_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_ACTIVELEVEL TAMPER ACTIVE LEVEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_ACTIVELEVEL_TAMP1 TAMP_CR2_TAMP1TRG /*!< Tamper 1 input falling edge (if TAMPFLT = 00) or staying high (if TAMPFLT != 00) triggers a tamper detection event */
@@ -565,6 +596,7 @@ typedef struct #if defined (RTC_TAMPCR_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER TAMPER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_1 RTC_TAMPCR_TAMP1E /*!< RTC_TAMP1 input detection */
@@ -581,6 +613,7 @@ typedef struct #if defined (RTC_TAMPCR_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_MASK TAMPER MASK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_MASK_TAMPER1 RTC_TAMPCR_TAMP1MF /*!< Tamper 1 event generates a trigger event. TAMP1F is masked and internally cleared by hardware.The backup registers are not erased */
@@ -597,6 +630,7 @@ typedef struct #if defined (RTC_TAMPCR_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_NOERASE TAMPER NO ERASE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_NOERASE_TAMPER1 RTC_TAMPCR_TAMP1NOERASE /*!< Tamper 1 event does not erase the backup registers. */
@@ -613,6 +647,7 @@ typedef struct #if defined(RTC_TAMPCR_TAMPPRCH)
/** @defgroup RTC_LL_EC_TAMPER_DURATION TAMPER DURATION
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_DURATION_1RTCCLK 0x00000000U /*!< Tamper pins are pre-charged before sampling during 1 RTCCLK cycle */
@@ -626,6 +661,7 @@ typedef struct #if defined(RTC_TAMPCR_TAMPFLT)
/** @defgroup RTC_LL_EC_TAMPER_FILTER TAMPER FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_FILTER_DISABLE 0x00000000U /*!< Tamper filter is disabled */
@@ -639,6 +675,7 @@ typedef struct #if defined(RTC_TAMPCR_TAMPFREQ)
/** @defgroup RTC_LL_EC_TAMPER_SAMPLFREQDIV TAMPER SAMPLING FREQUENCY DIVIDER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_SAMPLFREQDIV_32768 0x00000000U /*!< Each of the tamper inputs are sampled with a frequency = RTCCLK / 32768 */
@@ -656,6 +693,7 @@ typedef struct #if defined (RTC_TAMPCR_TAMP1E)
/** @defgroup RTC_LL_EC_TAMPER_ACTIVELEVEL TAMPER ACTIVE LEVEL
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_ACTIVELEVEL_TAMP1 RTC_TAMPCR_TAMP1TRG /*!< RTC_TAMP1 input falling edge (if TAMPFLT = 00) or staying high (if TAMPFLT != 00) triggers a tamper detection event*/
@@ -672,6 +710,7 @@ typedef struct #if defined(TAMP_ATCR1_TAMP1AM)
/** @defgroup RTC_LL_EC_ACTIVE_MODE ACTIVE TAMPER MODE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_ATAMP_TAMP1AM TAMP_ATCR1_TAMP1AM /*!< tamper 1 is active */
@@ -688,6 +727,7 @@ typedef struct #if defined(TAMP_ATCR1_ATCKSEL)
/** @defgroup RTC_LL_EC_ACTIVE_ASYNC_PRESCALER ACTIVE TAMPER ASYNCHRONOUS PRESCALER CLOCK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_ATAMP_ASYNCPRES_RTCCLK 0U /*!< RTCCLK */
@@ -705,6 +745,7 @@ typedef struct #if defined(TAMP_ATCR1_TAMP1AM)
/** @defgroup RTC_LL_EC_ACTIVE_OUTPUT_SELECTION ACTIVE TAMPER OUTPUT SELECTION
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_TAMPER_ATAMP1IN_ATAMP1OUT (0UL << TAMP_ATCR2_ATOSEL1_Pos)
@@ -728,6 +769,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_WAKEUPCLOCK_DIV WAKEUP CLOCK DIV
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_WAKEUPCLOCK_DIV_16 0x00000000U /*!< RTC/16 clock is selected */
@@ -741,6 +783,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_BKP BACKUP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_BKP_DR0 0x00000000U
@@ -780,6 +823,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_CALIB_OUTPUT Calibration output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_CALIB_OUTPUT_NONE 0x00000000U /*!< Calibration output disabled */
@@ -790,6 +834,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_CALIB_INSERTPULSE Calibration pulse insertion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_CALIB_INSERTPULSE_NONE 0x00000000U /*!< No RTCCLK pulses are added */
@@ -799,6 +844,7 @@ typedef struct */
/** @defgroup RTC_LL_EC_CALIB_PERIOD Calibration period
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_RTC_CALIB_PERIOD_32SEC 0x00000000U /*!< Use a 32-second calibration cycle period */
@@ -814,10 +860,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup RTC_LL_Exported_Macros RTC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTC_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -842,6 +890,7 @@ typedef struct */
/** @defgroup RTC_LL_EM_Convert Convert helper Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -864,6 +913,7 @@ typedef struct */
/** @defgroup RTC_LL_EM_Date Date helper Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -919,6 +969,7 @@ typedef struct */
/** @defgroup RTC_LL_EM_Time Time helper Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -953,10 +1004,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup RTC_LL_Exported_Functions RTC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup RTC_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1437,6 +1490,7 @@ __STATIC_INLINE void LL_RTC_DisableOutRemap(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_Time Time
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1738,6 +1792,7 @@ __STATIC_INLINE void LL_RTC_TIME_Synchronize(RTC_TypeDef *RTCx, uint32_t ShiftSe */
/** @defgroup RTC_LL_EF_Date Date
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1973,6 +2028,7 @@ __STATIC_INLINE uint32_t LL_RTC_DATE_Get(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_ALARMA ALARMA
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2339,6 +2395,7 @@ __STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecond(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_ALARMB ALARMB
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2705,6 +2762,7 @@ __STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecond(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_Timestamp Timestamp
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2946,6 +3004,7 @@ __STATIC_INLINE uint32_t LL_RTC_TS_GetSubSecond(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_Tamper_Timestamp Time-stamp on Tamper
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3003,6 +3062,7 @@ __STATIC_INLINE void LL_RTC_TS_DisableOnTamper(RTC_TypeDef *RTCx) */
/** @defgroup RTC_LL_EF_Tamper Tamper
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3565,6 +3625,7 @@ __STATIC_INLINE uint32_t LL_RTC_TAMPER_GetSamplingFreq(TAMP_TypeDef *TAMPx) */
/** @defgroup RTC_LL_EF_Wakeup Wakeup
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3670,6 +3731,7 @@ __STATIC_INLINE uint32_t LL_RTC_WAKEUP_GetAutoReload(RTC_TypeDef *RTCx) /** @defgroup RTC_LL_EF_Backup_Registers Backup_Registers
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3885,6 +3947,7 @@ __STATIC_INLINE uint32_t LL_RTC_BKP_GetRegister(TAMP_TypeDef *TAMPx, uint32_t Ba /** @defgroup RTC_LL_EF_Calibration Calibration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4011,6 +4074,7 @@ __STATIC_INLINE uint32_t LL_RTC_CAL_GetMinus(RTC_TypeDef *RTCx) /** @defgroup RTC_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4740,6 +4804,7 @@ __STATIC_INLINE void LL_RTC_ClearFlag_TAMP3(TAMP_TypeDef *TAMPx) */
/** @defgroup RTC_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -5149,6 +5214,7 @@ __STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_TAMP3(TAMP_TypeDef *TAMPx) #if defined (TAMP_ATCR1_TAMP1AM)
/** @defgroup RTC_LL_EF_Active_Tamper Active Tamper
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -5332,6 +5398,7 @@ __STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_ATAMP_SEEDF(void) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup RTC_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_sdmmc.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_sdmmc.h index 51ec6e9abc..8d5d03e255 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_sdmmc.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_sdmmc.h @@ -38,6 +38,7 @@ /* Exported types ------------------------------------------------------------*/
/** @defgroup SDMMC_LL_Exported_Types SDMMC_LL Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -125,6 +126,7 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup SDMMC_LL_Exported_Constants SDMMC_LL Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
@@ -324,6 +326,7 @@ typedef struct #define SDMMC_STOPTRANSFERTIMEOUT ((uint32_t)100000000U) /* Timeout for STOP TRANSMISSION command */
/** @defgroup SDMMC_LL_Clock_Edge Clock Edge
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_CLOCK_EDGE_RISING ((uint32_t)0x00000000U)
@@ -336,6 +339,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Clock_Power_Save Clock Power Saving
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_CLOCK_POWER_SAVE_DISABLE ((uint32_t)0x00000000U)
@@ -348,6 +352,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Bus_Wide Bus Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_BUS_WIDE_1B ((uint32_t)0x00000000U)
@@ -362,6 +367,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Speed_Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_SPEED_MODE_AUTO ((uint32_t)0x00000000U)
@@ -381,6 +387,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Hardware_Flow_Control Hardware Flow Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_HARDWARE_FLOW_CONTROL_DISABLE ((uint32_t)0x00000000U)
@@ -393,6 +400,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Clock_Division Clock Division
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* SDMMC_CK frequency = SDMMCCLK / [2 * CLKDIV] */
@@ -402,6 +410,7 @@ typedef struct */
/** @defgroup SDMMC_LL_TRANSCEIVER_PRESENT Tranceiver Present
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_TRANSCEIVER_UNKNOWN ((uint32_t)0x00000000U)
@@ -413,6 +422,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Command_Index Command Index
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_SDMMC_CMD_INDEX(INDEX) ((INDEX) < 0x40U)
@@ -421,6 +431,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Response_Type Response Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_RESPONSE_NO ((uint32_t)0x00000000U)
@@ -435,6 +446,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Wait_Interrupt_State Wait Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_WAIT_NO ((uint32_t)0x00000000U)
@@ -449,6 +461,7 @@ typedef struct */
/** @defgroup SDMMC_LL_CPSM_State CPSM State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_CPSM_DISABLE ((uint32_t)0x00000000U)
@@ -461,6 +474,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Response_Registers Response Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_RESP1 ((uint32_t)0x00000000U)
@@ -474,6 +488,7 @@ typedef struct ((RESP) == SDMMC_RESP4))
/** @defgroup SDMMC_Internal_DMA_Mode SDMMC Internal DMA Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_DISABLE_IDMA ((uint32_t)0x00000000)
@@ -486,6 +501,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Data_Length Data Lenght
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define IS_SDMMC_DATA_LENGTH(LENGTH) ((LENGTH) <= 0x01FFFFFFU)
@@ -494,6 +510,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Data_Block_Size Data Block Size
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_DATABLOCK_SIZE_1B ((uint32_t)0x00000000U)
@@ -532,6 +549,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Transfer_Direction Transfer Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_TRANSFER_DIR_TO_CARD ((uint32_t)0x00000000U)
@@ -544,6 +562,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Transfer_Type Transfer Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_TRANSFER_MODE_BLOCK ((uint32_t)0x00000000U)
@@ -556,6 +575,7 @@ typedef struct */
/** @defgroup SDMMC_LL_DPSM_State DPSM State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_DPSM_DISABLE ((uint32_t)0x00000000U)
@@ -568,6 +588,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Read_Wait_Mode Read Wait Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_READ_WAIT_MODE_DATA2 ((uint32_t)0x00000000U)
@@ -580,6 +601,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Interrupt_sources Interrupt Sources
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_IT_CCRCFAIL SDMMC_MASK_CCRCFAILIE
@@ -610,6 +632,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Flags Flags
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SDMMC_FLAG_CCRCFAIL SDMMC_STA_CCRCFAIL
@@ -667,10 +690,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup SDMMC_LL_Exported_macros SDMMC_LL Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SDMMC_LL_Register Bits And Addresses Definitions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SDMMC_LL registers bit address in the alias region
* @{
*/
@@ -707,6 +732,7 @@ typedef struct */
/** @defgroup SDMMC_LL_Interrupt_Clock Interrupt And Clock Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_spi.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_spi.h index 2808474e53..437b27ef35 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_spi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_spi.h @@ -35,6 +35,7 @@ extern "C" { #if defined(SPI1) || defined(SPI2) || defined(SPI3) || defined(SPI4) || defined(SPI5) || defined(SPI6)
/** @defgroup SPI_LL SPI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -45,6 +46,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SPI_LL_Private_Macros SPI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -115,10 +117,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup SPI_LL_Exported_Constants SPI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPI_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_SPI_ReadReg function
* @{
*/
@@ -141,6 +145,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_SPI_ReadReg and LL_SPI_WriteReg functions
* @{
*/
@@ -160,6 +165,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_MODE Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_MODE_MASTER (SPI_CFG2_MASTER)
@@ -169,6 +175,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_SS_LEVEL SS Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_SS_LEVEL_HIGH (SPI_CR1_SSI)
@@ -178,6 +185,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_SS_IDLENESS SS Idleness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_SS_IDLENESS_00CYCLE (0x00000000UL)
@@ -201,6 +209,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_ID_IDLENESS Master Inter-Data Idleness
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_ID_IDLENESS_00CYCLE (0x00000000UL)
@@ -224,6 +233,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_TXCRCINIT_ALL TXCRC Init All
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_TXCRCINIT_ALL_ZERO_PATTERN (0x00000000UL)
@@ -233,6 +243,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_RXCRCINIT_ALL RXCRC Init All
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_RXCRCINIT_ALL_ZERO_PATTERN (0x00000000UL)
@@ -242,6 +253,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_UDR_CONFIG_REGISTER UDR Config Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_UDR_CONFIG_REGISTER_PATTERN (0x00000000UL)
@@ -252,6 +264,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_UDR_DETECT_BEGIN_DATA UDR Detect Begin Data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_UDR_DETECT_BEGIN_DATA_FRAME (0x00000000UL)
@@ -262,6 +275,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_PROTOCOL Protocol
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_PROTOCOL_MOTOROLA (0x00000000UL)
@@ -271,6 +285,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_PHASE Phase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_PHASE_1EDGE (0x00000000UL)
@@ -280,6 +295,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_POLARITY Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_POLARITY_LOW (0x00000000UL)
@@ -289,6 +305,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_NSS_POLARITY NSS Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_NSS_POLARITY_LOW (0x00000000UL)
@@ -298,6 +315,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_BAUDRATEPRESCALER Baud Rate Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_BAUDRATEPRESCALER_DIV2 (0x00000000UL)
@@ -313,6 +331,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_BIT_ORDER Bit Order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_LSB_FIRST (SPI_CFG2_LSBFRST)
@@ -322,6 +341,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_TRANSFER_MODE Transfer Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_FULL_DUPLEX (0x00000000UL)
@@ -334,6 +354,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_DATAWIDTH Data Width
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_DATAWIDTH_4BIT (SPI_CFG1_DSIZE_0 | SPI_CFG1_DSIZE_1)
@@ -370,6 +391,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_FIFO_TH FIFO Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_FIFO_TH_01DATA (0x00000000UL)
@@ -395,6 +417,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SPI_LL_EC_CRC_CALCULATION CRC Calculation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_CRCCALCULATION_DISABLE (0x00000000UL) /*!< CRC calculation disabled */
@@ -405,6 +428,7 @@ typedef struct #endif /* USE_FULL_LL_DRIVER */
/** @defgroup SPI_LL_EC_CRC CRC
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_CRC_4BIT (SPI_CFG1_CRCSIZE_0 | SPI_CFG1_CRCSIZE_1)
@@ -441,6 +465,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_NSS_MODE NSS Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_NSS_SOFT (SPI_CFG2_SSM)
@@ -451,6 +476,7 @@ typedef struct */
/** @defgroup SPI_LL_EC_RX_FIFO RxFIFO Packing LeVel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SPI_RX_FIFO_0PACKET (0x00000000UL) /* 0 or multiple of 4 packet available is the RxFIFO */
@@ -467,10 +493,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup SPI_LL_Exported_Macros SPI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPI_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -502,10 +530,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup SPI_LL_Exported_Functions SPI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SPI_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1648,6 +1678,7 @@ __STATIC_INLINE uint32_t LL_SPI_IsEnabledNSSPulse(SPI_TypeDef *SPIx) */
/** @defgroup SPI_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1935,6 +1966,7 @@ __STATIC_INLINE void LL_SPI_ClearFlag_SUSP(SPI_TypeDef *SPIx) */
/** @defgroup SPI_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2306,6 +2338,7 @@ __STATIC_INLINE uint32_t LL_SPI_IsEnabledIT_TSER(SPI_TypeDef *SPIx) */
/** @defgroup SPI_LL_EF_DMA_Management DMA Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2380,6 +2413,7 @@ __STATIC_INLINE uint32_t LL_SPI_IsEnabledDMAReq_TX(SPI_TypeDef *SPIx) */
/** @defgroup SPI_LL_EF_DATA_Management DATA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2531,6 +2565,7 @@ __STATIC_INLINE uint32_t LL_SPI_GetTxCRC(SPI_TypeDef *SPIx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SPI_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2547,6 +2582,7 @@ void LL_SPI_StructInit(LL_SPI_InitTypeDef *SPI_InitStruct); */
/** @defgroup I2S_LL I2S
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2557,6 +2593,7 @@ void LL_SPI_StructInit(LL_SPI_InitTypeDef *SPI_InitStruct); /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup I2S_LL_ES_INIT I2S Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2610,10 +2647,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup I2S_LL_Exported_Constants I2S Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2S_LL_EC_DATA_FORMAT Data Format
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_DATAFORMAT_16B (0x00000000UL)
@@ -2626,6 +2665,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_CHANNEL_LENGTH_TYPE Type of Channel Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_SLAVE_VARIABLE_CH_LENGTH (0x00000000UL)
@@ -2635,6 +2675,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_POLARITY Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_POLARITY_LOW (0x00000000UL)
@@ -2644,6 +2685,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_STANDARD I2S Standard
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_STANDARD_PHILIPS (0x00000000UL)
@@ -2656,6 +2698,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_MODE Operation Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_MODE_SLAVE_TX (0x00000000UL)
@@ -2669,6 +2712,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_PRESCALER_PARITY Prescaler Factor
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_PRESCALER_PARITY_EVEN (0x00000000UL) /*!< Odd factor: Real divider value is = I2SDIV * 2 */
@@ -2678,6 +2722,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_FIFO_TH FIFO Threshold Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_FIFO_TH_01DATA (LL_SPI_FIFO_TH_01DATA)
@@ -2693,6 +2738,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_BIT_ORDER Transmission Bit Order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_LSB_FIRST (LL_SPI_LSB_FIRST)
@@ -2704,6 +2750,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup I2S_LL_EC_MCLK_OUTPUT MCLK Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_I2S_MCLK_OUTPUT_DISABLE (0x00000000UL)
@@ -2713,6 +2760,7 @@ typedef struct */
/** @defgroup I2S_LL_EC_AUDIO_FREQ Audio Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2737,10 +2785,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup I2S_LL_Exported_Macros I2S Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2S_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2772,10 +2822,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup I2S_LL_Exported_Functions I2S Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup I2S_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3274,6 +3326,7 @@ __STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock(SPI_TypeDef *SPIx) /** @defgroup I2S_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3370,6 +3423,7 @@ __STATIC_INLINE void LL_I2S_ClearFlag_FRE(SPI_TypeDef *SPIx) */
/** @defgroup I2S_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3543,6 +3597,7 @@ __STATIC_INLINE uint32_t LL_I2S_IsEnabledIT_FRE(SPI_TypeDef *SPIx) */
/** @defgroup I2S_LL_EF_DMA_Management DMA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3617,6 +3672,7 @@ __STATIC_INLINE uint32_t LL_I2S_IsEnabledDMAReq_TX(SPI_TypeDef *SPIx) */
/** @defgroup I2S_LL_EF_DATA_Management DATA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3673,6 +3729,7 @@ __STATIC_INLINE void LL_I2S_TransmitData32(SPI_TypeDef *SPIx, uint32_t TxData) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SPI_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_swpmi.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_swpmi.h index bfe722ee45..7f07516521 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_swpmi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_swpmi.h @@ -34,6 +34,7 @@ extern "C" { /** @defgroup SWPMI_LL SWPMI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -43,6 +44,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SWPMI_LL_Private_Macros SWPMI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -53,6 +55,7 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SWPMI_LL_ES_INIT SWPMI Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -91,10 +94,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup SWPMI_LL_Exported_Constants SWPMI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SWPMI_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_SWPMI_WriteReg function
* @{
*/
@@ -110,6 +115,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_SWPMI_ReadReg function
* @{
*/
@@ -129,6 +135,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_SWPMI_ReadReg and LL_SWPMI_WriteReg functions
* @{
*/
@@ -146,6 +153,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_SW_BUFFER_RX SW BUFFER RX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SWPMI_SW_BUFFER_RX_SINGLE ((uint32_t)0x00000000) /*!< Single software buffer mode for reception */
@@ -155,6 +163,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_SW_BUFFER_TX SW BUFFER TX
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SWPMI_SW_BUFFER_TX_SINGLE ((uint32_t)0x00000000) /*!< Single software buffer mode for transmission */
@@ -164,6 +173,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_VOLTAGE_CLASS VOLTAGE CLASS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SWPMI_VOLTAGE_CLASS_C ((uint32_t)0x00000000) /*!< SWPMI_IO uses directly VDD voltage to operate in class C */
@@ -173,6 +183,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EC_DMA_REG_DATA DMA register data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SWPMI_DMA_REG_DATA_TRANSMIT (uint32_t)0 /*!< Get address of data register used for transmission */
@@ -187,10 +198,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup SWPMI_LL_Exported_Macros SWPMI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SWPMI_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -215,6 +228,7 @@ typedef struct */
/** @defgroup SWPMI_LL_EM_BitRate Bit rate calculation helper Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -237,10 +251,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup SWPMI_LL_Exported_Functions SWPMI Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SWPMI_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -466,6 +482,7 @@ __STATIC_INLINE uint32_t LL_SWPMI_GetVoltageClass(SWPMI_TypeDef *SWPMIx) */
/** @defgroup SWPMI_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -698,6 +715,7 @@ __STATIC_INLINE void LL_SWPMI_ClearFlag_RDY(SWPMI_TypeDef *SWPMIx) */
/** @defgroup SWPMI_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1036,6 +1054,7 @@ __STATIC_INLINE uint32_t LL_SWPMI_IsEnabledIT_RXBF(SWPMI_TypeDef *SWPMIx) */
/** @defgroup SWPMI_LL_EF_DMA_Management DMA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1138,6 +1157,7 @@ __STATIC_INLINE uint32_t LL_SWPMI_DMA_GetRegAddr(SWPMI_TypeDef *SWPMIx, uint32_t */
/** @defgroup SWPMI_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1208,6 +1228,7 @@ __STATIC_INLINE void LL_SWPMI_DisableTXBypass(SWPMI_TypeDef *SWPMIx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup SWPMI_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_system.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_system.h index 77fc4ff5c4..450f8c293f 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_system.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_system.h @@ -47,6 +47,7 @@ extern "C" { #if defined (FLASH) || defined (SYSCFG) || defined (DBGMCU)
/** @defgroup SYSTEM_LL SYSTEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -55,9 +56,11 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup SYSTEM_LL_Private_Constants SYSTEM Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SYSTEM_LL_EC_FLASH_BANK1_SECTORS SYSCFG Flash Bank1 sectors bits status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_FLASH_B1_SECTOR0_STATUS_BIT 0x10000U
@@ -73,6 +76,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_FLASH_BANK2_SECTORS SYSCFG Flash Bank2 sectors bits status
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_FLASH_B2_SECTOR0_STATUS_BIT 0x10000U
@@ -95,10 +99,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup SYSTEM_LL_Exported_Constants SYSTEM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SYSTEM_LL_EC_I2C_FASTMODEPLUS SYSCFG I2C FASTMODEPLUS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_I2C_FASTMODEPLUS_I2C1 SYSCFG_PMCR_I2C1_FMP /*!< Enable Fast Mode Plus for I2C1 */
@@ -114,6 +120,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_ANALOG_SWITCH Analog Switch control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_ANALOG_SWITCH_BOOSTEN SYSCFG_PMCR_BOOSTEN /*!< I/O analog switch voltage booster enable */
@@ -127,6 +134,7 @@ extern "C" { #if defined(SYSCFG_PMCR_EPIS_SEL)
/** @defgroup SYSTEM_LL_EC_EPIS Ethernet PHY Interface Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_ETH_MII 0x00000000U /*!< ETH Media MII interface */
@@ -137,6 +145,7 @@ extern "C" { #endif /* SYSCFG_PMCR_EPIS_SEL */
/** @defgroup SYSTEM_LL_EC_EXTI_PORT SYSCFG EXTI PORT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_EXTI_PORTA 0U /*!< EXTI PORT A */
@@ -155,6 +164,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_EXTI_LINE SYSCFG EXTI LINE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_EXTI_LINE0 ((0x000FUL << 16U) | 0U) /*!< EXTI_POSITION_0 | EXTICR[0] */
@@ -178,6 +188,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_TIMBREAK SYSCFG TIMER BREAK
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_TIMBREAK_AXISRAM_DBL_ECC SYSCFG_CFGR_AXISRAML /*!< Enables and locks the AXIRAM double ECC error signal
@@ -222,6 +233,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_CS SYSCFG I/O compensation cell Code selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_CELL_CODE 0U
@@ -231,6 +243,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_IWDG1_CONTROL_MODES SYSCFG IWDG1 control modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_IWDG1_SW_CONTROL_MODE 0U
@@ -241,6 +254,7 @@ extern "C" { #if defined (DUAL_CORE)
/** @defgroup SYSTEM_LL_IWDG2_CONTROL_MODES SYSCFG IWDG2 control modes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_IWDG2_SW_CONTROL_MODE 0U
@@ -251,6 +265,7 @@ extern "C" { #endif /* DUAL_CORE */
/** @defgroup SYSTEM_LL_DTCM_RAM_SIZE SYSCFG DTCM RAM size configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_DTCM_RAM_SIZE_2KB 0U
@@ -262,6 +277,7 @@ extern "C" { */
#ifdef SYSCFG_PKGR_PKG
/** @defgroup SYSTEM_LL_PACKAGE SYSCFG device package
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_LQFP100_PACKAGE 0U
@@ -274,6 +290,7 @@ extern "C" { #endif /* SYSCFG_PKGR_PKG */
/** @defgroup SYSTEM_LL_SYSCFG_BOR SYSCFG Brownout Reset Threshold Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_SYSCFG_BOR_OFF_RESET_LEVEL 0x00000000U
@@ -286,6 +303,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_TRACE DBGMCU TRACE Pin Assignment
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_TRACE_NONE 0x00000000U /*!< TRACE pins not assigned (default state) */
@@ -298,6 +316,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_APB1_GRP1_STOP_IP DBGMCU APB1 GRP1 STOP IP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_APB1_GRP1_TIM2_STOP DBGMCU_APB1LFZ1_DBG_TIM2 /*!< TIM2 counter stopped when core is halted */
@@ -318,6 +337,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_APB1_GRP2_STOP_IP DBGMCU APB1 GRP2 STOP IP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_APB1_GRP2_FDCAN_STOP DBGMCU_APB1HFZ1_DBG_FDCAN /*!< FDCAN is frozen while the core is in debug mode */
@@ -326,6 +346,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_APB2_GRP1_STOP_IP DBGMCU APB2 GRP1 STOP IP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_APB2_GRP1_TIM1_STOP DBGMCU_APB2FZ1_DBG_TIM1 /*!< TIM1 counter stopped when core is halted */
@@ -339,6 +360,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_APB3_GRP1_STOP_IP DBGMCU APB3 GRP1 STOP IP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_APB3_GRP1_WWDG1_STOP DBGMCU_APB3FZ1_DBG_WWDG1 /*!< WWDG1 is frozen while the core is in debug mode */
@@ -347,6 +369,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_APB4_GRP1_STOP_IP DBGMCU APB4 GRP1 STOP IP
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_DBGMCU_APB4_GRP1_I2C4_STOP DBGMCU_APB4FZ1_DBG_I2C4 /*!< I2C4 is frozen while the core is in debug mode */
@@ -361,6 +384,7 @@ extern "C" { */
/** @defgroup SYSTEM_LL_EC_LATENCY FLASH LATENCY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_FLASH_LATENCY_0 FLASH_ACR_LATENCY_0WS /*!< FLASH Zero wait state */
@@ -383,10 +407,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup SYSTEM_LL_Exported_Functions SYSTEM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SYSTEM_LL_EF_SYSCFG SYSCFG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1653,6 +1679,7 @@ __STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_IOHSLV(void) */
/** @defgroup SYSTEM_LL_EF_DBGMCU DBGMCU
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2144,6 +2171,7 @@ __STATIC_INLINE void LL_DBGMCU_APB4_GRP1_UnFreezePeriph(uint32_t Periphs) */
/** @defgroup SYSTEM_LL_EF_FLASH FLASH
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2190,6 +2218,7 @@ __STATIC_INLINE uint32_t LL_FLASH_GetLatency(void) #if defined(DUAL_CORE)
/** @defgroup SYSTEM_LL_EF_ART ART
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_tim.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_tim.h index a196cbe89e..ef92960c8e 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_tim.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_tim.h @@ -35,12 +35,14 @@ extern "C" { #if defined (TIM1) || defined (TIM2) || defined (TIM3) || defined (TIM4) || defined (TIM5) || defined (TIM6) || defined (TIM7) || defined (TIM8) || defined (TIM12) || defined (TIM13) || defined (TIM14) || defined (TIM15) || defined (TIM16) || defined (TIM17)
/** @defgroup TIM_LL TIM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup TIM_LL_Private_Variables TIM Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
static const uint8_t OFFSET_TAB_CCMRx[] =
@@ -113,6 +115,7 @@ static const uint8_t SHIFT_TAB_OISx[] = /* Private constants ---------------------------------------------------------*/
/** @defgroup TIM_LL_Private_Constants TIM Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -145,6 +148,7 @@ static const uint8_t SHIFT_TAB_OISx[] = /* Private macros ------------------------------------------------------------*/
/** @defgroup TIM_LL_Private_Macros TIM Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @brief Convert channel id into channel index.
@@ -190,6 +194,7 @@ static const uint8_t SHIFT_TAB_OISx[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup TIM_LL_ES_INIT TIM Exported Init structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -481,10 +486,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup TIM_LL_Exported_Constants TIM Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIM_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_TIM_ReadReg function.
* @{
*/
@@ -510,6 +517,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup TIM_LL_EC_BREAK_ENABLE Break Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK_DISABLE 0x00000000U /*!< Break function disabled */
@@ -519,6 +527,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BREAK2_ENABLE Break2 Enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK2_DISABLE 0x00000000U /*!< Break2 function disabled */
@@ -528,6 +537,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_AUTOMATICOUTPUT_ENABLE Automatic output enable
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_AUTOMATICOUTPUT_DISABLE 0x00000000U /*!< MOE can be set only by software */
@@ -538,6 +548,7 @@ typedef struct #endif /* USE_FULL_LL_DRIVER */
/** @defgroup TIM_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_TIM_ReadReg and LL_TIM_WriteReg functions.
* @{
*/
@@ -554,6 +565,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_UPDATESOURCE Update Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_UPDATESOURCE_REGULAR 0x00000000U /*!< Counter overflow/underflow, Setting the UG bit or Update generation through the slave mode controller generates an update request */
@@ -563,6 +575,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ONEPULSEMODE One Pulse Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ONEPULSEMODE_SINGLE TIM_CR1_OPM /*!< Counter is not stopped at update event */
@@ -572,6 +585,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_COUNTERMODE Counter Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_COUNTERMODE_UP 0x00000000U /*!<Counter used as upcounter */
@@ -584,6 +598,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_CLOCKDIVISION Clock Division
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_CLOCKDIVISION_DIV1 0x00000000U /*!< tDTS=tCK_INT */
@@ -594,6 +609,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_COUNTERDIRECTION Counter Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_COUNTERDIRECTION_UP 0x00000000U /*!< Timer counter counts up */
@@ -603,6 +619,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_CCUPDATESOURCE Capture Compare Update Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_CCUPDATESOURCE_COMG_ONLY 0x00000000U /*!< Capture/compare control bits are updated by setting the COMG bit only */
@@ -612,6 +629,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_CCDMAREQUEST Capture Compare DMA Request
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_CCDMAREQUEST_CC 0x00000000U /*!< CCx DMA request sent when CCx event occurs */
@@ -621,6 +639,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_LOCKLEVEL Lock Level
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_LOCKLEVEL_OFF 0x00000000U /*!< LOCK OFF - No bit is write protected */
@@ -632,6 +651,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_CHANNEL Channel
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_CHANNEL_CH1 TIM_CCER_CC1E /*!< Timer input/output channel 1 */
@@ -649,6 +669,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup TIM_LL_EC_OCSTATE Output Configuration State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OCSTATE_DISABLE 0x00000000U /*!< OCx is not active */
@@ -659,6 +680,7 @@ typedef struct #endif /* USE_FULL_LL_DRIVER */
/** @defgroup TIM_LL_EC_OCMODE Output Configuration Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OCMODE_FROZEN 0x00000000U /*!<The comparison between the output compare register TIMx_CCRy and the counter TIMx_CNT has no effect on the output channel level */
@@ -680,6 +702,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_OCPOLARITY Output Configuration Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OCPOLARITY_HIGH 0x00000000U /*!< OCxactive high*/
@@ -689,6 +712,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_OCIDLESTATE Output Configuration Idle State
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OCIDLESTATE_LOW 0x00000000U /*!<OCx=0 (after a dead-time if OC is implemented) when MOE=0*/
@@ -698,6 +722,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_GROUPCH5 GROUPCH5
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_GROUPCH5_NONE 0x00000000U /*!< No effect of OC5REF on OC1REFC, OC2REFC and OC3REFC */
@@ -709,6 +734,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ACTIVEINPUT Active Input Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ACTIVEINPUT_DIRECTTI (TIM_CCMR1_CC1S_0 << 16U) /*!< ICx is mapped on TIx */
@@ -719,6 +745,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ICPSC Input Configuration Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ICPSC_DIV1 0x00000000U /*!< No prescaler, capture is done each time an edge is detected on the capture input */
@@ -730,6 +757,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_IC_FILTER Input Configuration Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_IC_FILTER_FDIV1 0x00000000U /*!< No filter, sampling is done at fDTS */
@@ -753,6 +781,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_IC_POLARITY Input Configuration Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_IC_POLARITY_RISING 0x00000000U /*!< The circuit is sensitive to TIxFP1 rising edge, TIxFP1 is not inverted */
@@ -763,6 +792,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_CLOCKSOURCE Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_CLOCKSOURCE_INTERNAL 0x00000000U /*!< The timer is clocked by the internal clock provided from the RCC */
@@ -773,6 +803,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ENCODERMODE Encoder Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ENCODERMODE_X2_TI1 TIM_SMCR_SMS_0 /*!< Quadrature encoder mode 1, x2 mode - Counter counts up/down on TI1FP1 edge depending on TI2FP2 level */
@@ -783,6 +814,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TRGO Trigger Output
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TRGO_RESET 0x00000000U /*!< UG bit from the TIMx_EGR register is used as trigger output */
@@ -798,6 +830,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TRGO2 Trigger Output 2
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TRGO2_RESET 0x00000000U /*!< UG bit from the TIMx_EGR register is used as trigger output 2 */
@@ -821,6 +854,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_SLAVEMODE Slave Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_SLAVEMODE_DISABLED 0x00000000U /*!< Slave mode disabled */
@@ -833,6 +867,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TS Trigger Selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TS_ITR0 0x00000000U /*!< Internal Trigger 0 (ITR0) is used as trigger input */
@@ -858,6 +893,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ETR_POLARITY External Trigger Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ETR_POLARITY_NONINVERTED 0x00000000U /*!< ETR is non-inverted, active at high level or rising edge */
@@ -867,6 +903,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ETR_PRESCALER External Trigger Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ETR_PRESCALER_DIV1 0x00000000U /*!< ETR prescaler OFF */
@@ -878,6 +915,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_ETR_FILTER External Trigger Filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_ETR_FILTER_FDIV1 0x00000000U /*!< No filter, sampling is done at fDTS */
@@ -947,6 +985,7 @@ typedef struct #define LL_TIM_TIM24_ETRSOURCE_SAI1_FSB TIM2_AF1_ETRSEL_2 /* !< TIM24_ETR is connected to SAI1 FS_B */
/** @defgroup TIM_LL_EC_BREAK_POLARITY break polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK_POLARITY_LOW 0x00000000U /*!< Break input BRK is active low */
@@ -956,6 +995,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BREAK_FILTER break filter
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK_FILTER_FDIV1 0x00000000U /*!< No filter, BRK acts asynchronously */
@@ -979,6 +1019,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BREAK2_POLARITY BREAK2 POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK2_POLARITY_LOW 0x00000000U /*!< Break input BRK2 is active low */
@@ -988,6 +1029,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BREAK2_FILTER BREAK2 FILTER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK2_FILTER_FDIV1 0x00000000U /*!< No filter, BRK acts asynchronously */
@@ -1011,6 +1053,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_OSSI OSSI
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OSSI_DISABLE 0x00000000U /*!< When inactive, OCx/OCxN outputs are disabled */
@@ -1020,6 +1063,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_OSSR OSSR
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_OSSR_DISABLE 0x00000000U /*!< When inactive, OCx/OCxN outputs are disabled */
@@ -1030,6 +1074,7 @@ typedef struct #if defined(TIM_BREAK_INPUT_SUPPORT)
/** @defgroup TIM_LL_EC_BREAK_INPUT BREAK INPUT
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BREAK_INPUT_BKIN 0x00000000U /*!< TIMx_BKIN input */
@@ -1039,6 +1084,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BKIN_SOURCE BKIN SOURCE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BKIN_SOURCE_BKIN TIM1_AF1_BKINE /*!< BKIN input from AF controller */
@@ -1050,6 +1096,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_BKIN_POLARITY BKIN POLARITY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_BKIN_POLARITY_LOW TIM1_AF1_BKINP /*!< BRK BKIN input is active low */
@@ -1060,6 +1107,7 @@ typedef struct #endif /* TIM_BREAK_INPUT_SUPPORT */
/** @defgroup TIM_LL_EC_DMABURST_BASEADDR DMA Burst Base Address
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_DMABURST_BASEADDR_CR1 0x00000000U /*!< TIMx_CR1 register is the DMA base address for DMA burst */
@@ -1093,6 +1141,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_DMABURST_LENGTH DMA Burst Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_DMABURST_LENGTH_1TRANSFER 0x00000000U /*!< Transfer is done to 1 register starting from the DMA burst base address */
@@ -1118,6 +1167,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM1_TI1_RMP TIM1 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM1_TI1_RMP_GPIO 0x00000000U /* !< TIM1 input 1 is connected to GPIO */
@@ -1127,6 +1177,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM8_TI1_RMP TIM8 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM8_TI1_RMP_GPIO 0x00000000U /* !< TIM8 input 1 is connected to GPIO */
@@ -1136,6 +1187,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM2_TI4_RMP TIM2 Timer Input Ch4 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM2_TI4_RMP_GPIO 0x00000000U /* !< TIM2 input 4 is connected to GPIO */
@@ -1147,6 +1199,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM3_TI1_RMP TIM3 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM3_TI1_RMP_GPIO 0x00000000U /* !< TIM3 input 1 is connected to GPIO */
@@ -1158,6 +1211,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM5_TI1_RMP TIM5 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM5_TI1_RMP_GPIO 0x00000000U /* !< TIM5 input 1 is connected to GPIO */
@@ -1168,6 +1222,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM12_TI1_RMP TIM12 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM12_TI1_RMP_GPIO 0x00000000U /* !< TIM12 input 1 is connected to GPIO */
@@ -1177,6 +1232,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM15_TI1_RMP TIM15 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM15_TI1_RMP_GPIO 0x00000000U /* !< TIM15 input 1 is connected to GPIO */
@@ -1191,6 +1247,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM15_TI2_RMP TIM15 Timer Input Ch2 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM15_TI2_RMP_GPIO 0x00000000U /* !< TIM15 input 2 is connected to GPIO */
@@ -1202,6 +1259,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM16_TI1_RMP TIM16 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM16_TI1_RMP_GPIO 0x00000000U /* !< TIM16 input 1 is connected to GPIO */
@@ -1213,6 +1271,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM17_TI1_RMP TIM17 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM17_TI1_RMP_GPIO 0x00000000U /* !< TIM17 input 1 is connected to GPIO */
@@ -1224,6 +1283,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM23_TI4_RMP TIM23 Timer Input Ch4 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM23_TI4_RMP_GPIO 0x00000000U /* !< TIM23 input 4 is connected to GPIO */
@@ -1235,6 +1295,7 @@ typedef struct */
/** @defgroup TIM_LL_EC_TIM24_TI1_RMP TIM24 Timer Input Ch1 Remap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_TIM_TIM24_TI1_RMP_GPIO 0x00000000U /* !< TIM24 input 1 is connected to GPIO */
@@ -1257,10 +1318,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup TIM_LL_Exported_Macros TIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIM_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1284,6 +1347,7 @@ typedef struct */
/** @defgroup TIM_LL_EM_Exported_Macros Exported_Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1387,10 +1451,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup TIM_LL_Exported_Functions TIM Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup TIM_LL_EF_Time_Base Time Base configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1794,6 +1860,7 @@ __STATIC_INLINE uint32_t LL_TIM_IsActiveUIFCPY(uint32_t Counter) */
/** @defgroup TIM_LL_EF_Capture_Compare Capture Compare configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -1979,6 +2046,7 @@ __STATIC_INLINE uint32_t LL_TIM_CC_IsEnabledChannel(TIM_TypeDef *TIMx, uint32_t */
/** @defgroup TIM_LL_EF_Output_Channel Output channel configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -2705,6 +2773,7 @@ __STATIC_INLINE void LL_TIM_SetCH5CombinedChannels(TIM_TypeDef *TIMx, uint32_t G */
/** @defgroup TIM_LL_EF_Input_Channel Input channel configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3092,6 +3161,7 @@ __STATIC_INLINE uint32_t LL_TIM_IC_GetCaptureCH4(TIM_TypeDef *TIMx) */
/** @defgroup TIM_LL_EF_Clock_Selection Counter clock selection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3180,6 +3250,7 @@ __STATIC_INLINE void LL_TIM_SetEncoderMode(TIM_TypeDef *TIMx, uint32_t EncoderMo */
/** @defgroup TIM_LL_EF_Timer_Synchronization Timer synchronisation configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3441,6 +3512,7 @@ __STATIC_INLINE void LL_TIM_SetETRSource(TIM_TypeDef *TIMx, uint32_t ETRSource) */
/** @defgroup TIM_LL_EF_Break_Function Break function configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3760,6 +3832,7 @@ __STATIC_INLINE void LL_TIM_SetBreakInputSourcePolarity(TIM_TypeDef *TIMx, uint3 */
/** @defgroup TIM_LL_EF_DMA_Burst_Mode DMA burst mode configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3826,6 +3899,7 @@ __STATIC_INLINE void LL_TIM_ConfigDMABurst(TIM_TypeDef *TIMx, uint32_t DMABurstB */
/** @defgroup TIM_LL_EF_Timer_Inputs_Remapping Timer input remapping
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -3911,6 +3985,7 @@ __STATIC_INLINE void LL_TIM_SetRemap(TIM_TypeDef *TIMx, uint32_t Remap) */
/** @defgroup TIM_LL_EF_FLAG_Management FLAG-Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -4270,6 +4345,7 @@ __STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_SYSBRK(TIM_TypeDef *TIMx) */
/** @defgroup TIM_LL_EF_IT_Management IT-Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -4541,6 +4617,7 @@ __STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_BRK(TIM_TypeDef *TIMx) */
/** @defgroup TIM_LL_EF_DMA_Management DMA-Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -4779,6 +4856,7 @@ __STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_TRIG(TIM_TypeDef *TIMx) */
/** @defgroup TIM_LL_EF_EVENT_Management EVENT-Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -4886,6 +4964,7 @@ __STATIC_INLINE void LL_TIM_GenerateEvent_BRK2(TIM_TypeDef *TIMx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup TIM_LL_EF_Init Initialisation and deinitialisation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_usart.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_usart.h index 77b8f0f667..7852543a0a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_usart.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_usart.h @@ -35,12 +35,14 @@ extern "C" { #if defined (USART1) || defined (USART2) || defined (USART3) || defined (USART6) || defined (UART4) || defined (UART5) || defined (UART7) || defined (UART8) || defined (UART9) || defined (USART10)
/** @defgroup USART_LL USART
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup USART_LL_Private_Variables USART Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Array used to get the USART prescaler division decimal values versus @ref USART_LL_EC_PRESCALER values */
@@ -67,6 +69,7 @@ static const uint32_t USART_PRESCALER_TAB[] = /* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup USART_LL_Private_Macros USART Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -77,6 +80,7 @@ static const uint32_t USART_PRESCALER_TAB[] = /* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup USART_LL_ES_INIT USART Exported Init structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -166,10 +170,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup USART_LL_Exported_Constants USART Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USART_LL_EC_CLEAR_FLAG Clear Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_USART_WriteReg function
* @{
*/
@@ -193,6 +199,7 @@ typedef struct */
/** @defgroup USART_LL_EC_GET_FLAG Get Flags Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief Flags defines which can be used with LL_USART_ReadReg function
* @{
*/
@@ -229,6 +236,7 @@ typedef struct */
/** @defgroup USART_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_USART_ReadReg and LL_USART_WriteReg functions
* @{
*/
@@ -254,6 +262,7 @@ typedef struct */
/** @defgroup USART_LL_EC_FIFOTHRESHOLD FIFO Threshold
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_FIFOTHRESHOLD_1_8 0x00000000U /*!< FIFO reaches 1/8 of its depth */
@@ -267,6 +276,7 @@ typedef struct */
/** @defgroup USART_LL_EC_DIRECTION Communication Direction
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_DIRECTION_NONE 0x00000000U /*!< Transmitter and Receiver are disabled */
@@ -278,6 +288,7 @@ typedef struct */
/** @defgroup USART_LL_EC_PARITY Parity Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_PARITY_NONE 0x00000000U /*!< Parity control disabled */
@@ -288,6 +299,7 @@ typedef struct */
/** @defgroup USART_LL_EC_WAKEUP Wakeup
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_WAKEUP_IDLELINE 0x00000000U /*!< USART wake up from Mute mode on Idle Line */
@@ -297,6 +309,7 @@ typedef struct */
/** @defgroup USART_LL_EC_DATAWIDTH Datawidth
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_DATAWIDTH_7B USART_CR1_M1 /*!< 7 bits word length : Start bit, 7 data bits, n stop bits */
@@ -307,6 +320,7 @@ typedef struct */
/** @defgroup USART_LL_EC_OVERSAMPLING Oversampling
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
@@ -317,6 +331,7 @@ typedef struct #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup USART_LL_EC_CLOCK Clock Signal
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -328,6 +343,7 @@ typedef struct #endif /*USE_FULL_LL_DRIVER*/
/** @defgroup USART_LL_EC_LASTCLKPULSE Last Clock Pulse
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_LASTCLKPULSE_NO_OUTPUT 0x00000000U /*!< The clock pulse of the last data bit is not output to the SCLK pin */
@@ -337,6 +353,7 @@ typedef struct */
/** @defgroup USART_LL_EC_PHASE Clock Phase
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_PHASE_1EDGE 0x00000000U /*!< The first clock transition is the first data capture edge */
@@ -346,6 +363,7 @@ typedef struct */
/** @defgroup USART_LL_EC_POLARITY Clock Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_POLARITY_LOW 0x00000000U /*!< Steady low value on SCLK pin outside transmission window*/
@@ -355,6 +373,7 @@ typedef struct */
/** @defgroup USART_LL_EC_PRESCALER Clock Source Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_PRESCALER_DIV1 0x00000000U /*!< Input clock not devided */
@@ -374,6 +393,7 @@ typedef struct */
/** @defgroup USART_LL_EC_STOPBITS Stop Bits
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< 0.5 stop bit */
@@ -385,6 +405,7 @@ typedef struct */
/** @defgroup USART_LL_EC_TXRX TX RX Pins Swap
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_TXRX_STANDARD 0x00000000U /*!< TX/RX pins are used as defined in standard pinout */
@@ -394,6 +415,7 @@ typedef struct */
/** @defgroup USART_LL_EC_RXPIN_LEVEL RX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_RXPIN_LEVEL_STANDARD 0x00000000U /*!< RX pin signal works using the standard logic levels */
@@ -403,6 +425,7 @@ typedef struct */
/** @defgroup USART_LL_EC_TXPIN_LEVEL TX Pin Active Level Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_TXPIN_LEVEL_STANDARD 0x00000000U /*!< TX pin signal works using the standard logic levels */
@@ -412,6 +435,7 @@ typedef struct */
/** @defgroup USART_LL_EC_BINARY_LOGIC Binary Data Inversion
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_BINARY_LOGIC_POSITIVE 0x00000000U /*!< Logical data from the data register are send/received in positive/direct logic. (1=H, 0=L) */
@@ -421,6 +445,7 @@ typedef struct */
/** @defgroup USART_LL_EC_BITORDER Bit Order
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_BITORDER_LSBFIRST 0x00000000U /*!< data is transmitted/received with data bit 0 first, following the start bit */
@@ -430,6 +455,7 @@ typedef struct */
/** @defgroup USART_LL_EC_AUTOBAUD_DETECT_ON Autobaud Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_AUTOBAUD_DETECT_ON_STARTBIT 0x00000000U /*!< Measurement of the start bit is used to detect the baud rate */
@@ -441,6 +467,7 @@ typedef struct */
/** @defgroup USART_LL_EC_ADDRESS_DETECT Address Length Detection
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit address detection method selected */
@@ -450,6 +477,7 @@ typedef struct */
/** @defgroup USART_LL_EC_HWCONTROL Hardware Control
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_HWCONTROL_NONE 0x00000000U /*!< CTS and RTS hardware flow control disabled */
@@ -461,6 +489,7 @@ typedef struct */
/** @defgroup USART_LL_EC_WAKEUP_ON Wakeup Activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_WAKEUP_ON_ADDRESS 0x00000000U /*!< Wake up active on address match */
@@ -471,6 +500,7 @@ typedef struct */
/** @defgroup USART_LL_EC_IRDA_POWER IrDA Power
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_IRDA_POWER_NORMAL 0x00000000U /*!< IrDA normal power mode */
@@ -480,6 +510,7 @@ typedef struct */
/** @defgroup USART_LL_EC_LINBREAK_DETECT LIN Break Detection Length
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_LINBREAK_DETECT_10B 0x00000000U /*!< 10-bit break detection method selected */
@@ -489,6 +520,7 @@ typedef struct */
/** @defgroup USART_LL_EC_DE_POLARITY Driver Enable Polarity
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_DE_POLARITY_HIGH 0x00000000U /*!< DE signal is active high */
@@ -498,6 +530,7 @@ typedef struct */
/** @defgroup USART_LL_EC_DMA_REG_DATA DMA Register Data
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_USART_DMA_REG_DATA_TRANSMIT 0x00000000U /*!< Get address of data register used for transmission */
@@ -512,10 +545,12 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup USART_LL_Exported_Macros USART Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USART_LL_EM_WRITE_READ Common Write and read registers Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -540,6 +575,7 @@ typedef struct */
/** @defgroup USART_LL_EM_Exported_Macros_Helper Exported_Macros_Helper
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -600,10 +636,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup USART_LL_Exported_Functions USART Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup USART_LL_EF_Configuration Configuration functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -1991,6 +2029,7 @@ __STATIC_INLINE uint32_t LL_USART_GetBlockLength(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_IRDA Configuration functions related to Irda feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2098,6 +2137,7 @@ __STATIC_INLINE uint32_t LL_USART_GetIrdaPrescaler(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_Smartcard Configuration functions related to Smartcard feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2274,6 +2314,7 @@ __STATIC_INLINE uint32_t LL_USART_GetSmartcardGuardTime(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_HalfDuplex Configuration functions related to Half Duplex feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2321,6 +2362,7 @@ __STATIC_INLINE uint32_t LL_USART_IsEnabledHalfDuplex(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_SPI_SLAVE Configuration functions related to SPI Slave feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -2409,6 +2451,7 @@ __STATIC_INLINE uint32_t LL_USART_IsEnabledSPISlaveSelect(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_LIN Configuration functions related to LIN feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2487,6 +2530,7 @@ __STATIC_INLINE uint32_t LL_USART_IsEnabledLIN(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_Configuration_DE Configuration functions related to Driver Enable feature
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2619,6 +2663,7 @@ __STATIC_INLINE uint32_t LL_USART_GetDESignalPolarity(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_AdvancedConfiguration Advanced Configurations services
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -2903,6 +2948,7 @@ __STATIC_INLINE void LL_USART_ConfigMultiProcessMode(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -3430,6 +3476,7 @@ __STATIC_INLINE void LL_USART_ClearFlag_WKUP(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4089,6 +4136,7 @@ __STATIC_INLINE uint32_t LL_USART_IsEnabledIT_RXFT(USART_TypeDef *USARTx) */
/** @defgroup USART_LL_EF_DMA_Management DMA_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4224,6 +4272,7 @@ __STATIC_INLINE uint32_t LL_USART_DMA_GetRegAddr(USART_TypeDef *USARTx, uint32_t */
/** @defgroup USART_LL_EF_Data_Management Data_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4278,6 +4327,7 @@ __STATIC_INLINE void LL_USART_TransmitData9(USART_TypeDef *USARTx, uint16_t Valu */
/** @defgroup USART_LL_EF_Execution Execution
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -4350,6 +4400,7 @@ __STATIC_INLINE void LL_USART_RequestTxDataFlush(USART_TypeDef *USARTx) #if defined(USE_FULL_LL_DRIVER) || defined(__rtems__)
/** @defgroup USART_LL_EF_Init Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
ErrorStatus LL_USART_DeInit(USART_TypeDef *USARTx);
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_usb.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_usb.h index 503b12f3e3..47753e9461 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_usb.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_usb.h @@ -211,11 +211,13 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup PCD_Exported_Constants PCD Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
/** @defgroup USB_OTG_CORE VERSION ID
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_OTG_CORE_ID_300A 0x4F54300AU
@@ -225,6 +227,7 @@ typedef struct */
/** @defgroup USB_Core_Mode_ USB Core Mode
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_OTG_MODE_DEVICE 0U
@@ -235,6 +238,7 @@ typedef struct */
/** @defgroup USB_LL Device Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USBD_HS_SPEED 0U
@@ -247,6 +251,7 @@ typedef struct */
/** @defgroup USB_LL_Core_Speed USB Low Layer Core Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_OTG_SPEED_HIGH 0U
@@ -257,6 +262,7 @@ typedef struct */
/** @defgroup USB_LL_Core_PHY USB Low Layer Core PHY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_OTG_ULPI_PHY 1U
@@ -266,6 +272,7 @@ typedef struct */
/** @defgroup USB_LL_Turnaround_Timeout Turnaround Timeout Value
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#ifndef USBD_HS_TRDT_VALUE
@@ -280,6 +287,7 @@ typedef struct */
/** @defgroup USB_LL_Core_MPS USB Low Layer Core MPS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define USB_OTG_HS_MAX_PACKET_SIZE 512U
@@ -290,6 +298,7 @@ typedef struct */
/** @defgroup USB_LL_Core_PHY_Frequency USB Low Layer Core PHY Frequency
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0U << 1)
@@ -300,6 +309,7 @@ typedef struct */
/** @defgroup USB_LL_CORE_Frame_Interval USB Low Layer Core Frame Interval
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DCFG_FRAME_INTERVAL_80 0U
@@ -311,6 +321,7 @@ typedef struct */
/** @defgroup USB_LL_EP0_MPS USB Low Layer EP0 MPS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define DEP0CTL_MPS_64 0U
@@ -322,6 +333,7 @@ typedef struct */
/** @defgroup USB_LL_EP_Speed USB Low Layer EP Speed
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EP_SPEED_LOW 0U
@@ -332,6 +344,7 @@ typedef struct */
/** @defgroup USB_LL_EP_Type USB Low Layer EP Type
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define EP_TYPE_CTRL 0U
@@ -344,6 +357,7 @@ typedef struct */
/** @defgroup USB_LL_STS_Defines USB Low Layer STS Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define STS_GOUT_NAK 1U
@@ -356,6 +370,7 @@ typedef struct */
/** @defgroup USB_LL_HCFG_SPEED_Defines USB Low Layer HCFG Speed Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HCFG_30_60_MHZ 0U
@@ -366,6 +381,7 @@ typedef struct */
/** @defgroup USB_LL_HPRT0_PRTSPD_SPEED_Defines USB Low Layer HPRT0 PRTSPD Speed Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HPRT0_PRTSPD_HIGH_SPEED 0U
@@ -409,6 +425,7 @@ typedef struct /* Exported macro ------------------------------------------------------------*/
/** @defgroup USB_LL_Exported_Macros USB Low Layer Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_utils.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_utils.h index ca336c268f..531ab60f3d 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_utils.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_utils.h @@ -47,6 +47,7 @@ extern "C" { */
/** @defgroup UTILS_LL UTILS
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -55,6 +56,7 @@ extern "C" { /* Private constants ---------------------------------------------------------*/
/** @defgroup UTILS_LL_Private_Constants UTILS Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -82,6 +84,7 @@ extern "C" { /* Private macros ------------------------------------------------------------*/
/** @defgroup UTILS_LL_Private_Macros UTILS Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -89,6 +92,7 @@ extern "C" { */
/* Exported types ------------------------------------------------------------*/
/** @defgroup UTILS_LL_ES_INIT UTILS Exported structures
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -184,10 +188,12 @@ typedef struct /* Exported constants --------------------------------------------------------*/
/** @defgroup UTILS_LL_Exported_Constants UTILS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UTILS_EC_HSE_BYPASS HSE Bypass activation
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_UTILS_HSEBYPASS_OFF 0x00000000U /*!< HSE Bypass is not enabled */
@@ -197,6 +203,7 @@ typedef struct */
/** @defgroup UTILS_EC_PACKAGETYPE PACKAGE TYPE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#if defined(SYSCFG_PKGR_PKG)
@@ -231,10 +238,12 @@ typedef struct /* Exported functions --------------------------------------------------------*/
/** @defgroup UTILS_LL_Exported_Functions UTILS Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup UTILS_EF_DEVICE_ELECTRONIC_SIGNATURE DEVICE ELECTRONIC SIGNATURE
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -317,6 +326,7 @@ __STATIC_INLINE uint32_t LL_GetPackageType(void) */
/** @defgroup UTILS_LL_EF_DELAY DELAY
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -345,6 +355,7 @@ void LL_mDelay(uint32_t Delay); */
/** @defgroup UTILS_EF_SYSTEM SYSTEM
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_ll_wwdg.h b/bsps/arm/stm32h7/include/stm32h7xx_ll_wwdg.h index bc36ed88a1..ddc4f21746 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_ll_wwdg.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_ll_wwdg.h @@ -35,6 +35,7 @@ extern "C" { #if defined (WWDG1) || defined (WWDG2)
/** @defgroup WWDG_LL WWDG
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -45,10 +46,12 @@ extern "C" { /* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup WWDG_LL_Exported_Constants WWDG Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup WWDG_LL_EC_IT IT Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief IT defines which can be used with LL_WWDG_ReadReg and LL_WWDG_WriteReg functions
* @{
*/
@@ -58,6 +61,7 @@ extern "C" { */
/** @defgroup WWDG_LL_EC_PRESCALER PRESCALER
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define LL_WWDG_PRESCALER_1 0x00000000u /*!< WWDG counter clock = (PCLK1/4096)/1 */
@@ -78,9 +82,11 @@ extern "C" { /* Exported macro ------------------------------------------------------------*/
/** @defgroup WWDG_LL_Exported_Macros WWDG Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup WWDG_LL_EM_WRITE_READ Common Write and read registers macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -109,10 +115,12 @@ extern "C" { /* Exported functions --------------------------------------------------------*/
/** @defgroup WWDG_LL_Exported_Functions WWDG Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup WWDG_LL_EF_Configuration Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -246,6 +254,7 @@ __STATIC_INLINE uint32_t LL_WWDG_GetWindow(WWDG_TypeDef *WWDGx) */
/** @defgroup WWDG_LL_EF_FLAG_Management FLAG_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
@@ -278,6 +287,7 @@ __STATIC_INLINE void LL_WWDG_ClearFlag_EWKUP(WWDG_TypeDef *WWDGx) */
/** @defgroup WWDG_LL_EF_IT_Management IT_Management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/**
|