22 ******************************************************************************
33 * @file stm32f4xx_hal_adc.h
44 * @author MCD Application Team
5- * @version V1.7.1
6- * @date 14-April-2017
75 * @brief Header file containing functions prototypes of ADC HAL library.
86 ******************************************************************************
97 * @attention
@@ -455,60 +453,60 @@ typedef struct
455453 */
456454
457455/** @brief Reset ADC handle state
458- * @param __HANDLE__: ADC handle
456+ * @param __HANDLE__ ADC handle
459457 * @retval None
460458 */
461459#define __HAL_ADC_RESET_HANDLE_STATE (__HANDLE__ ) ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
462460
463461/**
464462 * @brief Enable the ADC peripheral.
465- * @param __HANDLE__: ADC handle
463+ * @param __HANDLE__ ADC handle
466464 * @retval None
467465 */
468466#define __HAL_ADC_ENABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 |= ADC_CR2_ADON)
469467
470468/**
471469 * @brief Disable the ADC peripheral.
472- * @param __HANDLE__: ADC handle
470+ * @param __HANDLE__ ADC handle
473471 * @retval None
474472 */
475473#define __HAL_ADC_DISABLE (__HANDLE__ ) ((__HANDLE__)->Instance->CR2 &= ~ADC_CR2_ADON)
476474
477475/**
478476 * @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.
481479 * @retval None
482480 */
483481#define __HAL_ADC_ENABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) |= (__INTERRUPT__))
484482
485483/**
486484 * @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.
489487 * @retval None
490488 */
491489#define __HAL_ADC_DISABLE_IT (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1) &= ~(__INTERRUPT__))
492490
493491/** @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.
496494 * @retval The new state of __IT__ (TRUE or FALSE).
497495 */
498496#define __HAL_ADC_GET_IT_SOURCE (__HANDLE__ , __INTERRUPT__ ) (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))
499497
500498/**
501499 * @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.
504502 * @retval None
505503 */
506504#define __HAL_ADC_CLEAR_FLAG (__HANDLE__ , __FLAG__ ) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
507505
508506/**
509507 * @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.
512510 * @retval None
513511 */
514512#define __HAL_ADC_GET_FLAG (__HANDLE__ , __FLAG__ ) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
@@ -616,7 +614,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
616614
617615/**
618616 * @brief Verification of ADC state: enabled or disabled
619- * @param __HANDLE__: ADC handle
617+ * @param __HANDLE__ ADC handle
620618 * @retval SET (ADC enabled) or RESET (ADC disabled)
621619 */
622620#define ADC_IS_ENABLE (__HANDLE__ ) \
@@ -626,7 +624,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
626624/**
627625 * @brief Test if conversion trigger of regular group is software start
628626 * or external trigger.
629- * @param __HANDLE__: ADC handle
627+ * @param __HANDLE__ ADC handle
630628 * @retval SET (software start) or RESET (external trigger)
631629 */
632630#define ADC_IS_SOFTWARE_START_REGULAR (__HANDLE__ ) \
@@ -635,7 +633,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
635633/**
636634 * @brief Test if conversion trigger of injected group is software start
637635 * or external trigger.
638- * @param __HANDLE__: ADC handle
636+ * @param __HANDLE__ ADC handle
639637 * @retval SET (software start) or RESET (external trigger)
640638 */
641639#define ADC_IS_SOFTWARE_START_INJECTED (__HANDLE__ ) \
@@ -652,7 +650,7 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
652650
653651/**
654652 * @brief Clear ADC error code (set it to error code: "no error")
655- * @param __HANDLE__: ADC handle
653+ * @param __HANDLE__ ADC handle
656654 * @retval None
657655 */
658656#define ADC_CLEAR_ERRORCODE (__HANDLE__ ) \
@@ -742,89 +740,89 @@ uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
742740
743741/**
744742 * @brief Set ADC Regular channel sequence length.
745- * @param _NbrOfConversion_: Regular channel sequence length.
743+ * @param _NbrOfConversion_ Regular channel sequence length.
746744 * @retval None
747745 */
748746#define ADC_SQR1 (_NbrOfConversion_ ) (((_NbrOfConversion_) - (uint8_t)1U) << 20U)
749747
750748/**
751749 * @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.
754752 * @retval None
755753 */
756754#define ADC_SMPR1 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3U * (((uint32_t)((uint16_t)(_CHANNELNB_))) - 10U)))
757755
758756/**
759757 * @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.
762760 * @retval None
763761 */
764762#define ADC_SMPR2 (_SAMPLETIME_ , _CHANNELNB_ ) ((_SAMPLETIME_) << (3U * ((uint32_t)((uint16_t)(_CHANNELNB_)))))
765763
766764/**
767765 * @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.
770768 * @retval None
771769 */
772770#define ADC_SQR3_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 1U)))
773771
774772/**
775773 * @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.
778776 * @retval None
779777 */
780778#define ADC_SQR2_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 7U)))
781779
782780/**
783781 * @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.
786784 * @retval None
787785 */
788786#define ADC_SQR1_RK (_CHANNELNB_ , _RANKNB_ ) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5U * ((_RANKNB_) - 13U)))
789787
790788/**
791789 * @brief Enable ADC continuous conversion mode.
792- * @param _CONTINUOUS_MODE_: Continuous mode.
790+ * @param _CONTINUOUS_MODE_ Continuous mode.
793791 * @retval None
794792 */
795793#define ADC_CR2_CONTINUOUS (_CONTINUOUS_MODE_ ) ((_CONTINUOUS_MODE_) << 1U)
796794
797795/**
798796 * @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.
800798 * @retval None
801799 */
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 )
803801
804802/**
805803 * @brief Enable ADC scan mode.
806- * @param _SCANCONV_MODE_: Scan conversion mode.
804+ * @param _SCANCONV_MODE_ Scan conversion mode.
807805 * @retval None
808806 */
809807#define ADC_CR1_SCANCONV (_SCANCONV_MODE_ ) ((_SCANCONV_MODE_) << 8U)
810808
811809/**
812810 * @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.
814812 * @retval None
815813 */
816814#define ADC_CR2_EOCSelection (_EOCSelection_MODE_ ) ((_EOCSelection_MODE_) << 10U)
817815
818816/**
819817 * @brief Enable the ADC DMA continuous request.
820- * @param _DMAContReq_MODE_: DMA continuous request mode.
818+ * @param _DMAContReq_MODE_ DMA continuous request mode.
821819 * @retval None
822820 */
823821#define ADC_CR2_DMAContReq (_DMAContReq_MODE_ ) ((_DMAContReq_MODE_) << 9U)
824822
825823/**
826824 * @brief Return resolution bits in CR1 register.
827- * @param __HANDLE__: ADC handle
825+ * @param __HANDLE__ ADC handle
828826 * @retval None
829827 */
830828#define ADC_GET_RESOLUTION (__HANDLE__ ) (((__HANDLE__)->Instance->CR1) & ADC_CR1_RES)
0 commit comments