ADC_Exported_Functions_Group2

Functions
HAL_StatusTypeDef	HAL_ADC_Start (ADC_HandleTypeDef *hadc)
	Enables ADC, starts conversion of regular group. Interruptions enabled in this function: None. More...
HAL_StatusTypeDef	HAL_ADC_Stop (ADC_HandleTypeDef *hadc)
	Stop ADC conversion of regular group, disable ADC peripheral. More...
HAL_StatusTypeDef	HAL_ADC_PollForConversion (ADC_HandleTypeDef *hadc, uint32_t Timeout)
	Wait for regular group conversion to be completed. More...
HAL_StatusTypeDef	HAL_ADC_Start_IT (ADC_HandleTypeDef *hadc)
	Start ADC with IRQ mode. More...
HAL_StatusTypeDef	HAL_ADC_Stop_IT (ADC_HandleTypeDef *hadc)
	Stop ADC irq mode. More...
HAL_StatusTypeDef	HAL_ADC_Start_DMA (ADC_HandleTypeDef *hadc, uint32_t *pData, uint32_t Length)
	start ADC convert with dma mode. More...
HAL_StatusTypeDef	HAL_ADC_Stop_DMA (ADC_HandleTypeDef *hadc)
	Stop ADC DMA transmit. More...
HAL_StatusTypeDef	HAL_ADC_DMA_PREPARE (ADC_HandleTypeDef *hadc)
	Configure adc power before start dma. More...
HAL_StatusTypeDef	HAL_ADC_DMA_WAIT_DONE (ADC_HandleTypeDef *hadc, uint32_t timeout)
	Wait ADC DMA done by polling mode. More...
uint32_t	HAL_ADC_GetValue (ADC_HandleTypeDef *hadc, uint32_t slot)
	Get ADC convert result. More...
HAL_StatusTypeDef	HAL_ADC_SetSource (ADC_HandleTypeDef *hadc, HAL_ADC_SRC__T src)
	Set ADC triger mode. More...
HAL_StatusTypeDef	HAL_ADC_SetTimer (ADC_HandleTypeDef *hadc, HAL_ADC_SRC_TIME_T src)
	set ADC timer triger mode. More...
HAL_StatusTypeDef	HAL_ADC_EnableSlot (ADC_HandleTypeDef *hadc, uint32_t slot, uint8_t en)
	Enable/Disable ADC slot/channel. More...
int	HAL_ADC_Get_Offset (ADC_HandleTypeDef *hadc)
	Get GPADC offset. More...

Detailed Description

Function Documentation

HAL_ADC_DMA_PREPARE()

HAL_StatusTypeDef HAL_ADC_DMA_PREPARE

(

ADC_HandleTypeDef *

hadc

)

Configure adc power before start dma.

Parameters

hadc	ADC handle.

Return values

HAL_StatusTypeDef

HAL_ADC_DMA_WAIT_DONE()

HAL_StatusTypeDef HAL_ADC_DMA_WAIT_DONE	(	ADC_HandleTypeDef *	hadc,
		uint32_t	timeout
	)

Wait ADC DMA done by polling mode.

Parameters

hadc	ADC handle.
timeout	wait time out in ms

Return values

HAL_StatusTypeDef

HAL_ADC_EnableSlot()

HAL_StatusTypeDef HAL_ADC_EnableSlot	(	ADC_HandleTypeDef *	hadc,
		uint32_t	slot,
		uint8_t	en
	)

Enable/Disable ADC slot/channel.

Parameters

hadc	ADC handle.
slot	ADC slot number.
en	enable 1 for disable 0.

Return values

HAL_StatusTypeDef.

HAL_ADC_Get_Offset()

int HAL_ADC_Get_Offset

(

ADC_HandleTypeDef *

hadc

)

Get GPADC offset.

Parameters

hadc	ADC handle.

Return values

adc

offset.

HAL_ADC_GetValue()

uint32_t HAL_ADC_GetValue	(	ADC_HandleTypeDef *	hadc,
		uint32_t	slot
	)

Get ADC convert result.

Parameters

hadc	ADC handle.
slot	ADC slot number.

Return values

ADC	convert result.

HAL_ADC_PollForConversion()

HAL_StatusTypeDef HAL_ADC_PollForConversion	(	ADC_HandleTypeDef *	hadc,
		uint32_t	Timeout
	)

Wait for regular group conversion to be completed.

Parameters

hadc	ADC handle
Timeout	Timeout value in millisecond.

Return values

HAL

status

HAL_ADC_SetSource()

HAL_StatusTypeDef HAL_ADC_SetSource	(	ADC_HandleTypeDef *	hadc,
		HAL_ADC_SRC__T	src
	)

Set ADC triger mode.

Parameters

hadc	ADC handle.
src	triger source mode.

Return values

HAL_StatusTypeDef.

HAL_ADC_SetTimer()

HAL_StatusTypeDef HAL_ADC_SetTimer	(	ADC_HandleTypeDef *	hadc,
		HAL_ADC_SRC_TIME_T	src
	)

set ADC timer triger mode.

Parameters

hadc	ADC handle.
src	timer index.

Return values

HAL_StatusTypeDef.

HAL_ADC_Start()

HAL_StatusTypeDef HAL_ADC_Start

(

ADC_HandleTypeDef *

hadc

)

Enables ADC, starts conversion of regular group. Interruptions enabled in this function: None.

Parameters

hadc	ADC handle

Return values

HAL

status

HAL_ADC_Start_DMA()

HAL_StatusTypeDef HAL_ADC_Start_DMA	(	ADC_HandleTypeDef *	hadc,
		uint32_t *	pData,
		uint32_t	Length
	)

start ADC convert with dma mode.

Parameters

hadc	ADC handle.
pData	data buffer.
Length	data lenght.

Return values

HAL_StatusTypeDef

HAL_ADC_Start_IT()

HAL_StatusTypeDef HAL_ADC_Start_IT

(

ADC_HandleTypeDef *

hadc

)

Start ADC with IRQ mode.

Parameters

hadc	ADC handle.

Return values

HAL_StatusTypeDef

HAL_ADC_Stop()

HAL_StatusTypeDef HAL_ADC_Stop

(

ADC_HandleTypeDef *

hadc

)

Stop ADC conversion of regular group, disable ADC peripheral.

Parameters

hadc	ADC handle

Return values

HAL

status.

HAL_ADC_Stop_DMA()

HAL_StatusTypeDef HAL_ADC_Stop_DMA

(

ADC_HandleTypeDef *

hadc

)

Stop ADC DMA transmit.

Parameters

hadc	ADC handle.

Return values

HAL_StatusTypeDef

HAL_ADC_Stop_IT()

HAL_StatusTypeDef HAL_ADC_Stop_IT

(

ADC_HandleTypeDef *

hadc

)

Stop ADC irq mode.

Parameters

hadc	ADC handle.

Return values

HAL_StatusTypeDef