summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h
diff options
context:
space:
mode:
authorKarel Gardas <karel@functional.vision>2023-07-21 14:24:09 +0200
committerKarel Gardas <karel@functional.vision>2023-07-31 15:15:10 +0200
commitba8ac65929f9e82892d44779a3c37d4cfea14ec7 (patch)
tree0606d24aa7ae7ec806837f2e67c70833ae0c58ee /bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h
parentbsps/stm32h7: workaround compilation issue with libbsd (diff)
downloadrtems-ba8ac65929f9e82892d44779a3c37d4cfea14ec7.tar.bz2
bsp/stm32h7: Add and use BSP Doxygen group
Inspired by: commit fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64 Author: Sebastian Huber <sebastian.huber@embedded-brains.de> Date: Thu Nov 26 08:13:52 2020 +0100 bsp/stm32h7: Add and use BSP Doxygen group Update #3910.
Diffstat (limited to '')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h
index 524a6a33b0..01938d417b 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_adc_ex.h
@@ -37,6 +37,7 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Types ADC Extended Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -225,10 +226,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 */
@@ -261,6 +264,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 */
@@ -272,6 +276,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) */
@@ -281,6 +286,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 */
@@ -294,6 +300,7 @@ typedef struct
#if defined(ADC_VER_V5_V90)
/** @defgroup ADCEx_OffsetSign ADC Extended Offset Sign
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define ADC3_OFFSET_SIGN_NEGATIVE (0x00000000UL) /*!< Offset sign negative, offset is subtracted */
@@ -304,6 +311,7 @@ typedef struct
#endif
/** @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 */
@@ -315,6 +323,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) */
@@ -327,6 +336,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 */
@@ -337,6 +347,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 */
@@ -357,6 +368,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) */
@@ -367,6 +379,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 |\
@@ -380,6 +393,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 |\
@@ -391,6 +405,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
@@ -401,6 +416,7 @@ typedef struct
*/
#if defined(ADC_VER_V5_V90)
/** @defgroup ADC_CFGR_fields_2 ADCx CFGR sub fields
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/* ADC_CFGR fields of parameters that can be updated when no conversion
@@ -413,6 +429,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. */
@@ -429,6 +446,7 @@ typedef struct
/* Exported macros -----------------------------------------------------------*/
/** @defgroup ADCEx_Exported_Macro ADC Extended Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -456,6 +474,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 */