summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.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_hrtim.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 'bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h93
1 files changed, 93 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h
index 7b709f3e7b..831c8431a0 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hrtim.h
@@ -41,6 +41,7 @@
* @{
*/
/** @defgroup HRTIM_Max_Timer HRTIM Max Timer
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MAX_HRTIM_TIMER 6U
@@ -52,6 +53,7 @@
*/
/** @defgroup HRTIM_Exported_Types HRTIM Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -527,10 +529,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
*/
@@ -546,6 +550,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_Timer_identifier HRTIM Timer identifier
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining timer identifiers
*/
@@ -560,6 +565,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_Compare_Unit HRTIM Compare Unit
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining compare unit identifiers
*/
@@ -572,6 +578,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_Capture_Unit HRTIM Capture Unit
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining capture unit identifiers
*/
@@ -582,6 +589,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_Timer_Output HRTIM Timer Output
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining timer output identifiers
*/
@@ -600,6 +608,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_ADC_Trigger HRTIM ADC Trigger
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining ADC triggers identifiers
*/
@@ -617,6 +626,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
*/
@@ -636,6 +646,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
*/
/** @defgroup HRTIM_Fault_Channel HRTIM Fault Channel
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
* @brief Constants defining fault channel identifiers
*/
@@ -650,6 +661,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.
*/
@@ -661,6 +673,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.
*/
@@ -672,6 +685,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.
*/
@@ -682,6 +696,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
*/
@@ -692,6 +707,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
*/
@@ -702,6 +718,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
*/
@@ -714,6 +731,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.
@@ -725,6 +743,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.
@@ -743,6 +762,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.
@@ -754,6 +774,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
@@ -767,6 +788,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.
@@ -778,6 +800,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
*/
@@ -792,6 +815,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
@@ -803,6 +827,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
@@ -814,6 +839,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
@@ -843,6 +869,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
@@ -859,6 +886,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
@@ -899,6 +927,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
@@ -911,6 +940,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),
@@ -925,6 +955,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
@@ -942,6 +973,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
*/
@@ -952,6 +984,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
@@ -993,6 +1026,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
* reset crossbar of a timer output
@@ -1034,6 +1068,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
@@ -1045,6 +1080,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
*/
@@ -1055,6 +1091,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
*/
@@ -1067,6 +1104,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
@@ -1078,6 +1116,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
@@ -1090,6 +1129,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
@@ -1131,6 +1171,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
@@ -1156,6 +1197,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
@@ -1168,6 +1210,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)
@@ -1182,6 +1225,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
@@ -1193,6 +1237,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
@@ -1204,6 +1249,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
@@ -1215,6 +1261,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
@@ -1226,6 +1273,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
@@ -1237,6 +1285,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
@@ -1248,6 +1297,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
*/
@@ -1272,6 +1322,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)
@@ -1289,6 +1340,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
@@ -1314,6 +1366,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)
@@ -1327,6 +1380,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
*/
@@ -1338,6 +1392,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
@@ -1351,6 +1406,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
*/
@@ -1362,6 +1418,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
*/
@@ -1374,6 +1431,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
*/
@@ -1384,6 +1442,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
@@ -1397,6 +1456,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
@@ -1408,6 +1468,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
@@ -1433,6 +1494,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)
@@ -1447,6 +1509,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
@@ -1458,6 +1521,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
*/
@@ -1468,6 +1532,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
@@ -1493,6 +1558,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
@@ -1504,6 +1570,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
@@ -1518,6 +1585,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
@@ -1529,6 +1597,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
*/
@@ -1547,6 +1616,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
@@ -1572,6 +1642,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
@@ -1584,6 +1655,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
@@ -1625,6 +1697,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).
@@ -1640,6 +1713,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
@@ -1718,6 +1792,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
@@ -1749,6 +1824,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
*/
@@ -1759,6 +1835,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
*/
@@ -1769,6 +1846,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
*/
@@ -1783,6 +1861,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
*/
@@ -1797,6 +1876,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
*/
@@ -1811,6 +1891,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
*/
@@ -1825,6 +1906,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
*/
@@ -1835,6 +1917,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
@@ -1846,6 +1929,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
@@ -1858,6 +1942,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 */
@@ -1873,6 +1958,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 */
@@ -1888,6 +1974,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 */
@@ -1910,6 +1997,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 */
@@ -1924,6 +2012,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 */
@@ -1938,6 +2027,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 */
@@ -1959,6 +2049,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 */
@@ -1974,6 +2065,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 */
@@ -2741,6 +2833,7 @@ typedef void (* pHRTIM_TIMxCallbackTypeDef)(HRTIM_HandleTypeDef *hhrtim, /*!<
/* Exported macros -----------------------------------------------------------*/
/** @defgroup HRTIM_Exported_Macros HRTIM Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/