@@ -490,60 +490,60 @@ typedef struct
490
490
*/
491
491
492
492
/** @brief Reset ADC handle state
493
- * @param __HANDLE__: ADC handle
493
+ * @param __HANDLE__ ADC handle
494
494
* @retval None
495
495
*/
496
496
#define __HAL_ADC_RESET_HANDLE_STATE (__HANDLE__ ) ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
497
497
498
498
/**
499
499
* @brief Enable the ADC peripheral.
500
- * @param __HANDLE__: ADC handle
500
+ * @param __HANDLE__ ADC handle
501
501
* @retval None
502
502
*/
503
503
#define __HAL_ADC_ENABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 |= ADC_CR2_ADON)
504
504
505
505
/**
506
506
* @brief Disable the ADC peripheral.
507
- * @param __HANDLE__: ADC handle
507
+ * @param __HANDLE__ ADC handle
508
508
* @retval None
509
509
*/
510
510
#define __HAL_ADC_DISABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 &= ~ADC_CR2_ADON)
511
511
512
512
/**
513
513
* @brief Enable the ADC end of conversion interrupt.
514
- * @param __HANDLE__: specifies the ADC Handle.
515
- * @param __INTERRUPT__: ADC Interrupt.
514
+ * @param __HANDLE__ specifies the ADC Handle.
515
+ * @param __INTERRUPT__ ADC Interrupt.
516
516
* @retval None
517
517
*/
518
518
#define __HAL_ADC_ENABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) |= (__INTERRUPT__))
519
519
520
520
/**
521
521
* @brief Disable the ADC end of conversion interrupt.
522
- * @param __HANDLE__: specifies the ADC Handle.
523
- * @param __INTERRUPT__: ADC interrupt.
522
+ * @param __HANDLE__ specifies the ADC Handle.
523
+ * @param __INTERRUPT__ ADC interrupt.
524
524
* @retval None
525
525
*/
526
526
#define __HAL_ADC_DISABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) &= ~(__INTERRUPT__))
527
527
528
528
/** @brief Check if the specified ADC interrupt source is enabled or disabled.
529
- * @param __HANDLE__: specifies the ADC Handle.
530
- * @param __INTERRUPT__: specifies the ADC interrupt source to check.
529
+ * @param __HANDLE__ specifies the ADC Handle.
530
+ * @param __INTERRUPT__ specifies the ADC interrupt source to check.
531
531
* @retval The new state of __IT__ (TRUE or FALSE).
532
532
*/
533
533
#define __HAL_ADC_GET_IT_SOURCE (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))
534
534
535
535
/**
536
536
* @brief Clear the ADC's pending flags.
537
- * @param __HANDLE__: specifies the ADC Handle.
538
- * @param __FLAG__: ADC flag.
537
+ * @param __HANDLE__ specifies the ADC Handle.
538
+ * @param __FLAG__ ADC flag.
539
539
* @retval None
540
540
*/
541
541
#define __HAL_ADC_CLEAR_FLAG (__HANDLE__ , __FLAG__ ) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
542
542
543
543
/**
544
544
* @brief Get the selected ADC's flag status.
545
- * @param __HANDLE__: specifies the ADC Handle.
546
- * @param __FLAG__: ADC flag.
545
+ * @param __HANDLE__ specifies the ADC Handle.
546
+ * @param __FLAG__ ADC flag.
547
547
* @retval None
548
548
*/
549
549
#define __HAL_ADC_GET_FLAG (__HANDLE__ , __FLAG__ ) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
@@ -651,7 +651,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
651
651
652
652
/**
653
653
* @brief Verification of ADC state: enabled or disabled
654
- * @param __HANDLE__: ADC handle
654
+ * @param __HANDLE__ ADC handle
655
655
* @retval SET (ADC enabled) or RESET (ADC disabled)
656
656
*/
657
657
#define ADC_IS_ENABLE (__HANDLE__ ) \
@@ -661,7 +661,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
661
661
/**
662
662
* @brief Test if conversion trigger of regular group is software start
663
663
* or external trigger.
664
- * @param __HANDLE__: ADC handle
664
+ * @param __HANDLE__ ADC handle
665
665
* @retval SET (software start) or RESET (external trigger)
666
666
*/
667
667
#define ADC_IS_SOFTWARE_START_REGULAR (__HANDLE__ ) \
@@ -670,7 +670,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
670
670
/**
671
671
* @brief Test if conversion trigger of injected group is software start
672
672
* or external trigger.
673
- * @param __HANDLE__: ADC handle
673
+ * @param __HANDLE__ ADC handle
674
674
* @retval SET (software start) or RESET (external trigger)
675
675
*/
676
676
#define ADC_IS_SOFTWARE_START_INJECTED (__HANDLE__ ) \
@@ -687,7 +687,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
687
687
688
688
/**
689
689
* @brief Clear ADC error code (set it to error code: "no error")
690
- * @param __HANDLE__: ADC handle
690
+ * @param __HANDLE__ ADC handle
691
691
* @retval None
692
692
*/
693
693
#define ADC_CLEAR_ERRORCODE (__HANDLE__ ) \
@@ -795,89 +795,89 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
795
795
796
796
/**
797
797
* @brief Set ADC Regular channel sequence length.
798
- * @param _NbrOfConversion_: Regular channel sequence length.
798
+ * @param _NbrOfConversion_ Regular channel sequence length.
799
799
* @retval None
800
800
*/
801
801
#define ADC_SQR1 (_NbrOfConversion_ ) (((_NbrOfConversion_) - (uint8_t)1) << 20)
802
802
803
803
/**
804
804
* @brief Set the ADC's sample time for channel numbers between 10 and 18.
805
- * @param _SAMPLETIME_: Sample time parameter.
806
- * @param _CHANNELNB_: Channel number.
805
+ * @param _SAMPLETIME_ Sample time parameter.
806
+ * @param _CHANNELNB_ Channel number.
807
807
* @retval None
808
808
*/
809
809
#define ADC_SMPR1 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3 * (((uint32_t)((uint16_t)(_CHANNELNB_))) - 10)))
810
810
811
811
/**
812
812
* @brief Set the ADC's sample time for channel numbers between 0 and 9.
813
- * @param _SAMPLETIME_: Sample time parameter.
814
- * @param _CHANNELNB_: Channel number.
813
+ * @param _SAMPLETIME_ Sample time parameter.
814
+ * @param _CHANNELNB_ Channel number.
815
815
* @retval None
816
816
*/
817
817
#define ADC_SMPR2 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3 * ((uint32_t)((uint16_t)(_CHANNELNB_)))))
818
818
819
819
/**
820
820
* @brief Set the selected regular channel rank for rank between 1 and 6.
821
- * @param _CHANNELNB_: Channel number.
822
- * @param _RANKNB_: Rank number.
821
+ * @param _CHANNELNB_ Channel number.
822
+ * @param _RANKNB_ Rank number.
823
823
* @retval None
824
824
*/
825
825
#define ADC_SQR3_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5 * ((_RANKNB_) - 1)))
826
826
827
827
/**
828
828
* @brief Set the selected regular channel rank for rank between 7 and 12.
829
- * @param _CHANNELNB_: Channel number.
830
- * @param _RANKNB_: Rank number.
829
+ * @param _CHANNELNB_ Channel number.
830
+ * @param _RANKNB_ Rank number.
831
831
* @retval None
832
832
*/
833
833
#define ADC_SQR2_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5 * ((_RANKNB_) - 7)))
834
834
835
835
/**
836
836
* @brief Set the selected regular channel rank for rank between 13 and 16.
837
- * @param _CHANNELNB_: Channel number.
838
- * @param _RANKNB_: Rank number.
837
+ * @param _CHANNELNB_ Channel number.
838
+ * @param _RANKNB_ Rank number.
839
839
* @retval None
840
840
*/
841
841
#define ADC_SQR1_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5 * ((_RANKNB_) - 13)))
842
842
843
843
/**
844
844
* @brief Enable ADC continuous conversion mode.
845
- * @param _CONTINUOUS_MODE_: Continuous mode.
845
+ * @param _CONTINUOUS_MODE_ Continuous mode.
846
846
* @retval None
847
847
*/
848
848
#define ADC_CR2_CONTINUOUS (_CONTINUOUS_MODE_ ) ((_CONTINUOUS_MODE_) << 1)
849
849
850
850
/**
851
851
* @brief Configures the number of discontinuous conversions for the regular group channels.
852
- * @param _NBR_DISCONTINUOUSCONV_: Number of discontinuous conversions.
852
+ * @param _NBR_DISCONTINUOUSCONV_ Number of discontinuous conversions.
853
853
* @retval None
854
854
*/
855
855
#define ADC_CR1_DISCONTINUOUS (_NBR_DISCONTINUOUSCONV_ ) (((_NBR_DISCONTINUOUSCONV_) - 1) << ADC_CR1_DISCNUM_Pos)
856
856
857
857
/**
858
858
* @brief Enable ADC scan mode.
859
- * @param _SCANCONV_MODE_: Scan conversion mode.
859
+ * @param _SCANCONV_MODE_ Scan conversion mode.
860
860
* @retval None
861
861
*/
862
862
#define ADC_CR1_SCANCONV (_SCANCONV_MODE_ ) ((_SCANCONV_MODE_) << 8)
863
863
864
864
/**
865
865
* @brief Enable the ADC end of conversion selection.
866
- * @param _EOCSelection_MODE_: End of conversion selection mode.
866
+ * @param _EOCSelection_MODE_ End of conversion selection mode.
867
867
* @retval None
868
868
*/
869
869
#define ADC_CR2_EOCSelection (_EOCSelection_MODE_ ) ((_EOCSelection_MODE_) << 10)
870
870
871
871
/**
872
872
* @brief Enable the ADC DMA continuous request.
873
- * @param _DMAContReq_MODE_: DMA continuous request mode.
873
+ * @param _DMAContReq_MODE_ DMA continuous request mode.
874
874
* @retval None
875
875
*/
876
876
#define ADC_CR2_DMAContReq (_DMAContReq_MODE_ ) ((_DMAContReq_MODE_) << 9)
877
877
878
878
/**
879
879
* @brief Return resolution bits in CR1 register.
880
- * @param __HANDLE__: ADC handle
880
+ * @param __HANDLE__ ADC handle
881
881
* @retval None
882
882
*/
883
883
#define ADC_GET_RESOLUTION (__HANDLE__ ) (((__HANDLE__)->Instance->CR1) & ADC_CR1_RES)
0 commit comments