@@ -460,15 +460,15 @@ typedef struct
460
460
461
461
/**
462
462
* @brief Enable the ADC peripheral
463
- * @param __HANDLE__: ADC handle
463
+ * @param __HANDLE__ ADC handle
464
464
* @retval None
465
465
*/
466
466
#define __HAL_ADC_ENABLE (__HANDLE__ ) \
467
467
((__HANDLE__)->Instance->CR |= ADC_CR_ADEN)
468
468
469
469
/**
470
470
* @brief Disable the ADC peripheral
471
- * @param __HANDLE__: ADC handle
471
+ * @param __HANDLE__ ADC handle
472
472
* @retval None
473
473
*/
474
474
#define __HAL_ADC_DISABLE (__HANDLE__ ) \
@@ -479,8 +479,8 @@ typedef struct
479
479
480
480
/**
481
481
* @brief Enable the ADC end of conversion interrupt.
482
- * @param __HANDLE__: ADC handle
483
- * @param __INTERRUPT__: ADC Interrupt
482
+ * @param __HANDLE__ ADC handle
483
+ * @param __INTERRUPT__ ADC Interrupt
484
484
* This parameter can be any combination of the following values:
485
485
* @arg ADC_IT_EOC: ADC End of Regular Conversion interrupt source
486
486
* @arg ADC_IT_EOS: ADC End of Regular sequence of Conversions interrupt source
@@ -495,8 +495,8 @@ typedef struct
495
495
496
496
/**
497
497
* @brief Disable the ADC end of conversion interrupt.
498
- * @param __HANDLE__: ADC handle
499
- * @param __INTERRUPT__: ADC Interrupt
498
+ * @param __HANDLE__ ADC handle
499
+ * @param __INTERRUPT__ ADC Interrupt
500
500
* This parameter can be any combination of the following values:
501
501
* @arg ADC_IT_EOC: ADC End of Regular Conversion interrupt source
502
502
* @arg ADC_IT_EOS: ADC End of Regular sequence of Conversions interrupt source
@@ -510,8 +510,8 @@ typedef struct
510
510
(((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))
511
511
512
512
/** @brief Checks if the specified ADC interrupt source is enabled or disabled.
513
- * @param __HANDLE__: ADC handle
514
- * @param __INTERRUPT__: ADC interrupt source to check
513
+ * @param __HANDLE__ ADC handle
514
+ * @param __INTERRUPT__ ADC interrupt source to check
515
515
* This parameter can be any combination of the following values:
516
516
* @arg ADC_IT_EOC: ADC End of Regular Conversion interrupt source
517
517
* @arg ADC_IT_EOS: ADC End of Regular sequence of Conversions interrupt source
@@ -526,8 +526,8 @@ typedef struct
526
526
527
527
/**
528
528
* @brief Get the selected ADC's flag status.
529
- * @param __HANDLE__: ADC handle
530
- * @param __FLAG__: ADC flag
529
+ * @param __HANDLE__ ADC handle
530
+ * @param __FLAG__ ADC flag
531
531
* This parameter can be any combination of the following values:
532
532
* @arg ADC_FLAG_EOC: ADC End of Regular conversion flag
533
533
* @arg ADC_FLAG_EOS: ADC End of Regular sequence of Conversions flag
@@ -542,8 +542,8 @@ typedef struct
542
542
543
543
/**
544
544
* @brief Clear the ADC's pending flags
545
- * @param __HANDLE__: ADC handle
546
- * @param __FLAG__: ADC flag
545
+ * @param __HANDLE__ ADC handle
546
+ * @param __FLAG__ ADC flag
547
547
* This parameter can be any combination of the following values:
548
548
* @arg ADC_FLAG_EOC: ADC End of Regular conversion flag
549
549
* @arg ADC_FLAG_EOS: ADC End of Regular sequence of Conversions flag
@@ -558,7 +558,7 @@ typedef struct
558
558
(((__HANDLE__)->Instance->ISR) = (__FLAG__))
559
559
560
560
/** @brief Reset ADC handle state
561
- * @param __HANDLE__: ADC handle
561
+ * @param __HANDLE__ ADC handle
562
562
* @retval None
563
563
*/
564
564
#define __HAL_ADC_RESET_HANDLE_STATE (__HANDLE__ ) \
@@ -580,7 +580,7 @@ typedef struct
580
580
581
581
/**
582
582
* @brief Verification of hardware constraints before ADC can be enabled
583
- * @param __HANDLE__: ADC handle
583
+ * @param __HANDLE__ ADC handle
584
584
* @retval SET (ADC can be enabled) or RESET (ADC cannot be enabled)
585
585
*/
586
586
#define ADC_ENABLING_CONDITIONS (__HANDLE__ ) \
@@ -591,7 +591,7 @@ typedef struct
591
591
592
592
/**
593
593
* @brief Verification of hardware constraints before ADC can be disabled
594
- * @param __HANDLE__: ADC handle
594
+ * @param __HANDLE__ ADC handle
595
595
* @retval SET (ADC can be disabled) or RESET (ADC cannot be disabled)
596
596
*/
597
597
#define ADC_DISABLING_CONDITIONS (__HANDLE__ ) \
@@ -601,7 +601,7 @@ typedef struct
601
601
602
602
/**
603
603
* @brief Verification of ADC state: enabled or disabled
604
- * @param __HANDLE__: ADC handle
604
+ * @param __HANDLE__ ADC handle
605
605
* @retval SET (ADC enabled) or RESET (ADC disabled)
606
606
*/
607
607
/* Note: If low power mode AutoPowerOff is enabled, power-on/off phases are */
@@ -616,15 +616,15 @@ typedef struct
616
616
/**
617
617
* @brief Test if conversion trigger of regular group is software start
618
618
* or external trigger.
619
- * @param __HANDLE__: ADC handle
619
+ * @param __HANDLE__ ADC handle
620
620
* @retval SET (software start) or RESET (external trigger)
621
621
*/
622
622
#define ADC_IS_SOFTWARE_START_REGULAR (__HANDLE__ ) \
623
623
(((__HANDLE__)->Instance->CFGR1 & ADC_CFGR1_EXTEN) == RESET)
624
624
625
625
/**
626
626
* @brief Check if no conversion on going on regular group
627
- * @param __HANDLE__: ADC handle
627
+ * @param __HANDLE__ ADC handle
628
628
* @retval SET (conversion is on going) or RESET (no conversion is on going)
629
629
*/
630
630
#define ADC_IS_CONVERSION_ONGOING_REGULAR (__HANDLE__ ) \
@@ -634,7 +634,7 @@ typedef struct
634
634
/**
635
635
* @brief Returns resolution bits in CFGR1 register: RES[1:0].
636
636
* Returned value is among parameters to @ref ADC_Resolution.
637
- * @param __HANDLE__: ADC handle
637
+ * @param __HANDLE__ ADC handle
638
638
* @retval None
639
639
*/
640
640
#define ADC_GET_RESOLUTION (__HANDLE__ ) \
@@ -643,7 +643,7 @@ typedef struct
643
643
/**
644
644
* @brief Returns ADC sample time bits in SMPR register: SMP[2:0].
645
645
* Returned value is among parameters to @ref ADC_Resolution.
646
- * @param __HANDLE__: ADC handle
646
+ * @param __HANDLE__ ADC handle
647
647
* @retval None
648
648
*/
649
649
#define ADC_GET_SAMPLINGTIME (__HANDLE__ ) \
@@ -660,7 +660,7 @@ typedef struct
660
660
661
661
/**
662
662
* @brief Clear ADC error code (set it to error code: "no error")
663
- * @param __HANDLE__: ADC handle
663
+ * @param __HANDLE__ ADC handle
664
664
* @retval None
665
665
*/
666
666
#define ADC_CLEAR_ERRORCODE (__HANDLE__ ) \
@@ -669,7 +669,7 @@ typedef struct
669
669
670
670
/**
671
671
* @brief Configure the channel number into channel selection register
672
- * @param _CHANNEL_: ADC Channel
672
+ * @param _CHANNEL_ ADC Channel
673
673
* @retval None
674
674
*/
675
675
/* This function converts ADC channels from numbers (see defgroup ADC_channels)
@@ -699,7 +699,7 @@ typedef struct
699
699
700
700
/**
701
701
* @brief Set the ADC's sample time
702
- * @param _SAMPLETIME_: Sample time parameter.
702
+ * @param _SAMPLETIME_ Sample time parameter.
703
703
* @retval None
704
704
*/
705
705
/* Note: ADC sampling time set using mask ADC_SMPR_SMP due to parameter */
@@ -712,47 +712,47 @@ typedef struct
712
712
713
713
/**
714
714
* @brief Set the Analog Watchdog 1 channel.
715
- * @param _CHANNEL_: channel to be monitored by Analog Watchdog 1.
715
+ * @param _CHANNEL_ channel to be monitored by Analog Watchdog 1.
716
716
* @retval None
717
717
*/
718
718
#define ADC_CFGR_AWDCH (_CHANNEL_ ) \
719
719
((_CHANNEL_) << 26U)
720
720
721
721
/**
722
722
* @brief Enable ADC discontinuous conversion mode for regular group
723
- * @param _REG_DISCONTINUOUS_MODE_: Regular discontinuous mode.
723
+ * @param _REG_DISCONTINUOUS_MODE_ Regular discontinuous mode.
724
724
* @retval None
725
725
*/
726
726
#define ADC_CFGR1_REG_DISCCONTINUOUS (_REG_DISCONTINUOUS_MODE_ ) \
727
727
((_REG_DISCONTINUOUS_MODE_) << 16U)
728
728
729
729
/**
730
730
* @brief Enable the ADC auto off mode.
731
- * @param _AUTOOFF_: Auto off bit enable or disable.
731
+ * @param _AUTOOFF_ Auto off bit enable or disable.
732
732
* @retval None
733
733
*/
734
734
#define ADC_CFGR1_AUTOOFF (_AUTOOFF_ ) \
735
735
((_AUTOOFF_) << 15U)
736
736
737
737
/**
738
738
* @brief Enable the ADC auto delay mode.
739
- * @param _AUTOWAIT_: Auto delay bit enable or disable.
739
+ * @param _AUTOWAIT_ Auto delay bit enable or disable.
740
740
* @retval None
741
741
*/
742
742
#define ADC_CFGR1_AUTOWAIT (_AUTOWAIT_ ) \
743
743
((_AUTOWAIT_) << 14U)
744
744
745
745
/**
746
746
* @brief Enable ADC continuous conversion mode.
747
- * @param _CONTINUOUS_MODE_: Continuous mode.
747
+ * @param _CONTINUOUS_MODE_ Continuous mode.
748
748
* @retval None
749
749
*/
750
750
#define ADC_CFGR1_CONTINUOUS (_CONTINUOUS_MODE_ ) \
751
751
((_CONTINUOUS_MODE_) << 13U)
752
752
753
753
/**
754
754
* @brief Enable ADC overrun mode.
755
- * @param _OVERRUN_MODE_: Overrun mode.
755
+ * @param _OVERRUN_MODE_ Overrun mode.
756
756
* @retval Overun bit setting to be programmed into CFGR register
757
757
*/
758
758
/* Note: Bit ADC_CFGR1_OVRMOD not used directly in constant */
@@ -765,7 +765,7 @@ typedef struct
765
765
766
766
/**
767
767
* @brief Enable ADC scan mode to convert multiple ranks with sequencer.
768
- * @param _SCAN_MODE_: Scan conversion mode.
768
+ * @param _SCAN_MODE_ Scan conversion mode.
769
769
* @retval None
770
770
*/
771
771
/* Note: Scan mode set using this macro (instead of parameter direct set) */
@@ -779,15 +779,15 @@ typedef struct
779
779
780
780
/**
781
781
* @brief Enable the ADC DMA continuous request.
782
- * @param _DMACONTREQ_MODE_: DMA continuous request mode.
782
+ * @param _DMACONTREQ_MODE_ DMA continuous request mode.
783
783
* @retval None
784
784
*/
785
785
#define ADC_CFGR1_DMACONTREQ (_DMACONTREQ_MODE_ ) \
786
786
((_DMACONTREQ_MODE_) << 1U)
787
787
788
788
/**
789
789
* @brief Configure the analog watchdog high threshold into register TR.
790
- * @param _Threshold_: Threshold value
790
+ * @param _Threshold_ Threshold value
791
791
* @retval None
792
792
*/
793
793
#define ADC_TRX_HIGHTHRESHOLD (_Threshold_ ) \
@@ -801,8 +801,8 @@ typedef struct
801
801
* If resolution 8 bits, shift of 4 ranks on the left.
802
802
* If resolution 6 bits, shift of 6 ranks on the left.
803
803
* therefore, shift = (12 - resolution) = 12 - (12- (((RES[1:0]) >> 3)*2))
804
- * @param __HANDLE__: ADC handle
805
- * @param _Threshold_: Value to be shifted
804
+ * @param __HANDLE__ ADC handle
805
+ * @param _Threshold_ Value to be shifted
806
806
* @retval None
807
807
*/
808
808
#define ADC_AWD1THRESHOLD_SHIFT_RESOLUTION (__HANDLE__ , _Threshold_ ) \
0 commit comments