Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

Operation on ADC hierarchical scope: group regular

Operation on ADC hierarchical scope: group regular
[ADC Exported Functions]

Functions

__STATIC_INLINE void LL_ADC_REG_StartConversion (ADC_TypeDef *ADCx)
 Start ADC group regular conversion.
__STATIC_INLINE void LL_ADC_REG_StopConversion (ADC_TypeDef *ADCx)
 Stop ADC group regular conversion.
__STATIC_INLINE uint32_t LL_ADC_REG_IsConversionOngoing (ADC_TypeDef *ADCx)
 Get ADC group regular conversion state.
__STATIC_INLINE uint32_t LL_ADC_REG_IsStopConversionOngoing (ADC_TypeDef *ADCx)
 Get ADC group regular command of conversion stop state (0: no command of conversion stop is on going on ADC group regular).
__STATIC_INLINE uint32_t LL_ADC_REG_ReadConversionData32 (ADC_TypeDef *ADCx)
 Get ADC group regular conversion data, range fit for all ADC configurations: all ADC resolutions and all oversampling increased data width (for devices with feature oversampling).
__STATIC_INLINE uint16_t LL_ADC_REG_ReadConversionData12 (ADC_TypeDef *ADCx)
 Get ADC group regular conversion data, range fit for ADC resolution 12 bits.
__STATIC_INLINE uint16_t LL_ADC_REG_ReadConversionData10 (ADC_TypeDef *ADCx)
 Get ADC group regular conversion data, range fit for ADC resolution 10 bits.
__STATIC_INLINE uint8_t LL_ADC_REG_ReadConversionData8 (ADC_TypeDef *ADCx)
 Get ADC group regular conversion data, range fit for ADC resolution 8 bits.
__STATIC_INLINE uint8_t LL_ADC_REG_ReadConversionData6 (ADC_TypeDef *ADCx)
 Get ADC group regular conversion data, range fit for ADC resolution 6 bits.
__STATIC_INLINE uint32_t LL_ADC_REG_ReadMultiConversionData32 (ADC_Common_TypeDef *ADCxy_COMMON, uint32_t ConvData)
 Get ADC multimode conversion data of ADC master, ADC slave or raw data with ADC master and slave concatenated.

Function Documentation

__STATIC_INLINE uint32_t LL_ADC_REG_IsConversionOngoing ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion state.

(0: no conversion is on going on ADC group regular) CR ADSTART LL_ADC_REG_IsConversionOngoing

Parameters:
ADCxADC instance
Return values:
Stateof bit (1 or 0).

Definition at line 5307 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint32_t LL_ADC_REG_IsStopConversionOngoing ( ADC_TypeDef *  ADCx )

Get ADC group regular command of conversion stop state (0: no command of conversion stop is on going on ADC group regular).

CR ADSTP LL_ADC_REG_IsStopConversionOngoing

Parameters:
ADCxADC instance
Return values:
Stateof bit (1 or 0).

Definition at line 5319 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint16_t LL_ADC_REG_ReadConversionData10 ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion data, range fit for ADC resolution 10 bits.

Note:
For devices with feature oversampling: Oversampling can increase data width, function for extended range may be needed: LL_ADC_REG_ReadConversionData32. DR RDATA LL_ADC_REG_ReadConversionData10
Parameters:
ADCxADC instance
Return values:
0x000...0x3FF

Definition at line 5363 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint16_t LL_ADC_REG_ReadConversionData12 ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion data, range fit for ADC resolution 12 bits.

Note:
For devices with feature oversampling: Oversampling can increase data width, function for extended range may be needed: LL_ADC_REG_ReadConversionData32. DR RDATA LL_ADC_REG_ReadConversionData12
Parameters:
ADCxADC instance
Return values:
0x000...0xFFF

Definition at line 5348 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint32_t LL_ADC_REG_ReadConversionData32 ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion data, range fit for all ADC configurations: all ADC resolutions and all oversampling increased data width (for devices with feature oversampling).

DR RDATA LL_ADC_REG_ReadConversionData32

Parameters:
ADCxADC instance
Return values:
0x00000000...0xFFFFFFFF

Definition at line 5333 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint8_t LL_ADC_REG_ReadConversionData6 ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion data, range fit for ADC resolution 6 bits.

Note:
For devices with feature oversampling: Oversampling can increase data width, function for extended range may be needed: LL_ADC_REG_ReadConversionData32. DR RDATA LL_ADC_REG_ReadConversionData6
Parameters:
ADCxADC instance
Return values:
0x00...0x3F

Definition at line 5393 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint8_t LL_ADC_REG_ReadConversionData8 ( ADC_TypeDef *  ADCx )

Get ADC group regular conversion data, range fit for ADC resolution 8 bits.

Note:
For devices with feature oversampling: Oversampling can increase data width, function for extended range may be needed: LL_ADC_REG_ReadConversionData32. DR RDATA LL_ADC_REG_ReadConversionData8
Parameters:
ADCxADC instance
Return values:
0x00...0xFF

Definition at line 5378 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE uint32_t LL_ADC_REG_ReadMultiConversionData32 ( ADC_Common_TypeDef *  ADCxy_COMMON,
uint32_t  ConvData 
)

Get ADC multimode conversion data of ADC master, ADC slave or raw data with ADC master and slave concatenated.

Note:
If raw data with ADC master and slave concatenated is retrieved, a macro is available to get the conversion data of ADC master or ADC slave: see helper macro __LL_ADC_MULTI_CONV_DATA_MASTER_SLAVE(). (however this macro is mainly intended for multimode transfer by DMA, because this function can do the same by getting multimode conversion data of ADC master or ADC slave separately). CDR RDATA_MST LL_ADC_REG_ReadMultiConversionData32
CDR RDATA_SLV LL_ADC_REG_ReadMultiConversionData32
Parameters:
ADCxy_COMMONADC common instance (can be set directly from CMSIS definition or by using helper macro __LL_ADC_COMMON_INSTANCE() )
ConvDataThis parameter can be one of the following values:

  • LL_ADC_MULTI_MASTER
  • LL_ADC_MULTI_SLAVE
  • LL_ADC_MULTI_MASTER_SLAVE
Return values:
0x00000000...0xFFFFFFFF

Definition at line 5420 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE void LL_ADC_REG_StartConversion ( ADC_TypeDef *  ADCx )

Start ADC group regular conversion.

Note:
On this STM32 family, this function is relevant for both internal trigger (SW start) and external trigger:
  • If ADC trigger has been set to software start, ADC conversion starts immediately.
  • If ADC trigger has been set to external trigger, ADC conversion will start at next trigger event (on the selected trigger edge) following the ADC start conversion command.
On this STM32 family, setting of this feature is conditioned to ADC state: ADC must be enabled without conversion on going on group regular, without conversion stop command on going on group regular. CR ADSTART LL_ADC_REG_StartConversion
Parameters:
ADCxADC instance
Return values:
None

Definition at line 5270 of file stm32l4xx_ll_adc.h.

__STATIC_INLINE void LL_ADC_REG_StopConversion ( ADC_TypeDef *  ADCx )

Stop ADC group regular conversion.

Note:
On this STM32 family, setting of this feature is conditioned to ADC state: ADC must be enabled with conversion on going on group regular, without ADC disable command on going. CR ADSTP LL_ADC_REG_StopConversion
Parameters:
ADCxADC instance
Return values:
None

Definition at line 5290 of file stm32l4xx_ll_adc.h.