diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_adc.h | 30 |
1 files changed, 30 insertions, 0 deletions
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 * @{
*/
|