2
2
******************************************************************************
3
3
* @file stm32f2xx_hal_adc.h
4
4
* @author MCD Application Team
5
- * @version V1.2.1
6
- * @date 14-April-2017
7
5
* @brief Header file of ADC HAL extension module.
8
6
******************************************************************************
9
7
* @attention
@@ -449,60 +447,60 @@ typedef struct
449
447
*/
450
448
451
449
/** @brief Reset ADC handle state
452
- * @param __HANDLE__: ADC handle
450
+ * @param __HANDLE__ ADC handle
453
451
* @retval None
454
452
*/
455
453
#define __HAL_ADC_RESET_HANDLE_STATE (__HANDLE__ ) ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
456
454
457
455
/**
458
456
* @brief Enable the ADC peripheral.
459
- * @param __HANDLE__: ADC handle
457
+ * @param __HANDLE__ ADC handle
460
458
* @retval None
461
459
*/
462
460
#define __HAL_ADC_ENABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 |= ADC_CR2_ADON)
463
461
464
462
/**
465
463
* @brief Disable the ADC peripheral.
466
- * @param __HANDLE__: ADC handle
464
+ * @param __HANDLE__ ADC handle
467
465
* @retval None
468
466
*/
469
467
#define __HAL_ADC_DISABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 &= ~ADC_CR2_ADON)
470
468
471
469
/**
472
470
* @brief Enable the ADC end of conversion interrupt.
473
- * @param __HANDLE__: specifies the ADC Handle.
474
- * @param __INTERRUPT__: ADC Interrupt.
471
+ * @param __HANDLE__ specifies the ADC Handle.
472
+ * @param __INTERRUPT__ ADC Interrupt.
475
473
* @retval None
476
474
*/
477
475
#define __HAL_ADC_ENABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) |= (__INTERRUPT__))
478
476
479
477
/**
480
478
* @brief Disable the ADC end of conversion interrupt.
481
- * @param __HANDLE__: specifies the ADC Handle.
482
- * @param __INTERRUPT__: ADC interrupt.
479
+ * @param __HANDLE__ specifies the ADC Handle.
480
+ * @param __INTERRUPT__ ADC interrupt.
483
481
* @retval None
484
482
*/
485
483
#define __HAL_ADC_DISABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) &= ~(__INTERRUPT__))
486
484
487
485
/** @brief Check if the specified ADC interrupt source is enabled or disabled.
488
- * @param __HANDLE__: specifies the ADC Handle.
489
- * @param __INTERRUPT__: specifies the ADC interrupt source to check.
486
+ * @param __HANDLE__ specifies the ADC Handle.
487
+ * @param __INTERRUPT__ specifies the ADC interrupt source to check.
490
488
* @retval The new state of __IT__ (TRUE or FALSE).
491
489
*/
492
490
#define __HAL_ADC_GET_IT_SOURCE (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))
493
491
494
492
/**
495
493
* @brief Clear the ADC's pending flags.
496
- * @param __HANDLE__: specifies the ADC Handle.
497
- * @param __FLAG__: ADC flag.
494
+ * @param __HANDLE__ specifies the ADC Handle.
495
+ * @param __FLAG__ ADC flag.
498
496
* @retval None
499
497
*/
500
498
#define __HAL_ADC_CLEAR_FLAG (__HANDLE__ , __FLAG__ ) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
501
499
502
500
/**
503
501
* @brief Get the selected ADC's flag status.
504
- * @param __HANDLE__: specifies the ADC Handle.
505
- * @param __FLAG__: ADC flag.
502
+ * @param __HANDLE__ specifies the ADC Handle.
503
+ * @param __FLAG__ ADC flag.
506
504
* @retval None
507
505
*/
508
506
#define __HAL_ADC_GET_FLAG (__HANDLE__ , __FLAG__ ) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
@@ -610,7 +608,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
610
608
611
609
/**
612
610
* @brief Verification of ADC state: enabled or disabled
613
- * @param __HANDLE__: ADC handle
611
+ * @param __HANDLE__ ADC handle
614
612
* @retval SET (ADC enabled) or RESET (ADC disabled)
615
613
*/
616
614
#define ADC_IS_ENABLE (__HANDLE__ ) \
@@ -620,7 +618,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
620
618
/**
621
619
* @brief Test if conversion trigger of regular group is software start
622
620
* or external trigger.
623
- * @param __HANDLE__: ADC handle
621
+ * @param __HANDLE__ ADC handle
624
622
* @retval SET (software start) or RESET (external trigger)
625
623
*/
626
624
#define ADC_IS_SOFTWARE_START_REGULAR (__HANDLE__ ) \
@@ -629,7 +627,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
629
627
/**
630
628
* @brief Test if conversion trigger of injected group is software start
631
629
* or external trigger.
632
- * @param __HANDLE__: ADC handle
630
+ * @param __HANDLE__ ADC handle
633
631
* @retval SET (software start) or RESET (external trigger)
634
632
*/
635
633
#define ADC_IS_SOFTWARE_START_INJECTED (__HANDLE__ ) \
@@ -646,7 +644,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
646
644
647
645
/**
648
646
* @brief Clear ADC error code (set it to error code: "no error")
649
- * @param __HANDLE__: ADC handle
647
+ * @param __HANDLE__ ADC handle
650
648
* @retval None
651
649
*/
652
650
#define ADC_CLEAR_ERRORCODE (__HANDLE__ ) \
@@ -736,89 +734,89 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
736
734
737
735
/**
738
736
* @brief Set ADC Regular channel sequence length.
739
- * @param _NbrOfConversion_: Regular channel sequence length.
737
+ * @param _NbrOfConversion_ Regular channel sequence length.
740
738
* @retval None
741
739
*/
742
740
#define ADC_SQR1 (_NbrOfConversion_ ) (((_NbrOfConversion_) - (uint8_t)1) << 20U)
743
741
744
742
/**
745
743
* @brief Set the ADC's sample time for channel numbers between 10 and 18.
746
- * @param _SAMPLETIME_: Sample time parameter.
747
- * @param _CHANNELNB_: Channel number.
744
+ * @param _SAMPLETIME_ Sample time parameter.
745
+ * @param _CHANNELNB_ Channel number.
748
746
* @retval None
749
747
*/
750
748
#define ADC_SMPR1 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3U * (((uint32_t)((uint16_t)(_CHANNELNB_))) - 10U)))
751
749
752
750
/**
753
751
* @brief Set the ADC's sample time for channel numbers between 0 and 9.
754
- * @param _SAMPLETIME_: Sample time parameter.
755
- * @param _CHANNELNB_: Channel number.
752
+ * @param _SAMPLETIME_ Sample time parameter.
753
+ * @param _CHANNELNB_ Channel number.
756
754
* @retval None
757
755
*/
758
756
#define ADC_SMPR2 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3U * ((uint32_t)((uint16_t)(_CHANNELNB_)))))
759
757
760
758
/**
761
759
* @brief Set the selected regular channel rank for rank between 1 and 6.
762
- * @param _CHANNELNB_: Channel number.
763
- * @param _RANKNB_: Rank number.
760
+ * @param _CHANNELNB_ Channel number.
761
+ * @param _RANKNB_ Rank number.
764
762
* @retval None
765
763
*/
766
764
#define ADC_SQR3_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 1U)))
767
765
768
766
/**
769
767
* @brief Set the selected regular channel rank for rank between 7 and 12.
770
- * @param _CHANNELNB_: Channel number.
771
- * @param _RANKNB_: Rank number.
768
+ * @param _CHANNELNB_ Channel number.
769
+ * @param _RANKNB_ Rank number.
772
770
* @retval None
773
771
*/
774
772
#define ADC_SQR2_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 7U)))
775
773
776
774
/**
777
775
* @brief Set the selected regular channel rank for rank between 13 and 16.
778
- * @param _CHANNELNB_: Channel number.
779
- * @param _RANKNB_: Rank number.
776
+ * @param _CHANNELNB_ Channel number.
777
+ * @param _RANKNB_ Rank number.
780
778
* @retval None
781
779
*/
782
780
#define ADC_SQR1_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 13U)))
783
781
784
782
/**
785
783
* @brief Enable ADC continuous conversion mode.
786
- * @param _CONTINUOUS_MODE_: Continuous mode.
784
+ * @param _CONTINUOUS_MODE_ Continuous mode.
787
785
* @retval None
788
786
*/
789
787
#define ADC_CR2_CONTINUOUS (_CONTINUOUS_MODE_ ) ((_CONTINUOUS_MODE_) << 1U)
790
788
791
789
/**
792
790
* @brief Configures the number of discontinuous conversions for the regular group channels.
793
- * @param _NBR_DISCONTINUOUSCONV_: Number of discontinuous conversions.
791
+ * @param _NBR_DISCONTINUOUSCONV_ Number of discontinuous conversions.
794
792
* @retval None
795
793
*/
796
794
#define ADC_CR1_DISCONTINUOUS (_NBR_DISCONTINUOUSCONV_ ) (((_NBR_DISCONTINUOUSCONV_) - 1U) << POSITION_VAL(ADC_CR1_DISCNUM))
797
795
798
796
/**
799
797
* @brief Enable ADC scan mode.
800
- * @param _SCANCONV_MODE_: Scan conversion mode.
798
+ * @param _SCANCONV_MODE_ Scan conversion mode.
801
799
* @retval None
802
800
*/
803
801
#define ADC_CR1_SCANCONV (_SCANCONV_MODE_ ) ((_SCANCONV_MODE_) << 8U)
804
802
805
803
/**
806
804
* @brief Enable the ADC end of conversion selection.
807
- * @param _EOCSelection_MODE_: End of conversion selection mode.
805
+ * @param _EOCSelection_MODE_ End of conversion selection mode.
808
806
* @retval None
809
807
*/
810
808
#define ADC_CR2_EOCSelection (_EOCSelection_MODE_ ) ((_EOCSelection_MODE_) << 10U)
811
809
812
810
/**
813
811
* @brief Enable the ADC DMA continuous request.
814
- * @param _DMAContReq_MODE_: DMA continuous request mode.
812
+ * @param _DMAContReq_MODE_ DMA continuous request mode.
815
813
* @retval None
816
814
*/
817
815
#define ADC_CR2_DMAContReq (_DMAContReq_MODE_ ) ((_DMAContReq_MODE_) << 9U)
818
816
819
817
/**
820
818
* @brief Return resolution bits in CR1 register.
821
- * @param __HANDLE__: ADC handle
819
+ * @param __HANDLE__ ADC handle
822
820
* @retval None
823
821
*/
824
822
#define ADC_GET_RESOLUTION (__HANDLE__ ) (((__HANDLE__)->Instance->CR1) & ADC_CR1_RES)
0 commit comments