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