adc_common.c File Reference

#include "hal/driver/driver.h"

Macros
#define	VSF_ADC_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_adc_init (vsf_adc_t *adc_ptr, vsf_adc_cfg_t *cfg_ptr)
	initialize a adc instance.
void	vsf_adc_fini (vsf_adc_t *adc_ptr)
	finalize a adc instance.
fsm_rt_t	vsf_adc_enable (vsf_adc_t *adc_ptr)
	enable interrupt masks of adc instance.
fsm_rt_t	vsf_adc_disable (vsf_adc_t *adc_ptr)
	disable interrupt masks of adc instance.
void	vsf_adc_irq_enable (vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
	enable interrupt masks of adc instance.
void	vsf_adc_irq_disable (vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
	disable interrupt masks of adc instance.
vsf_adc_status_t	vsf_adc_status (vsf_adc_t *adc_ptr)
	get the status of adc instance.
vsf_adc_capability_t	vsf_adc_capability (vsf_adc_t *adc_ptr)
	get the capability of adc instance.
vsf_err_t	vsf_adc_channel_request_once (vsf_adc_t *adc_ptr, vsf_adc_channel_cfg_t *channel_cfg, void *buffer_ptr)
	adc request sampling once
vsf_err_t	vsf_adc_channel_config (vsf_adc_t *adc_ptr, vsf_adc_channel_cfg_t *channel_cfgs_ptr, uint32_t channel_cfgs_cnt)
	adc channel configuration
vsf_err_t	vsf_adc_channel_request (vsf_adc_t *adc_ptr, void *buffer_ptr, uint_fast32_t count)
	adc channel request

Macro Definition Documentation

VSF_ADC_CFG_FUNCTION_RENAME

#define VSF_ADC_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_adc_init()

vsf_err_t vsf_adc_init	(	vsf_adc_t *	adc_ptr,
		vsf_adc_cfg_t *	cfg_ptr
	)

initialize a adc instance.

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	cfg_ptr	a pointer to structure vsf_adc_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if adc was initialized, or a negative error code

Note

It is not necessary to call vsf_adc_fini() to deinitialization. vsf_adc_init() should be called before any other ADC API except vsf_adc_capability().

vsf_adc_fini()

void vsf_adc_fini

(

vsf_adc_t *

adc_ptr

)

finalize a adc instance.

Parameters

[in]

adc_ptr

a pointer to structure vsf_adc_t

Returns

none

vsf_adc_enable()

fsm_rt_t vsf_adc_enable

(

vsf_adc_t *

adc_ptr

)

enable interrupt masks of adc instance.

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	irq_mask	one or more value of enum vsf_adc_irq_mask_t

Returns

none.

vsf_adc_disable()

fsm_rt_t vsf_adc_disable

(

vsf_adc_t *

adc_ptr

)

disable interrupt masks of adc instance.

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	irq_mask	one or more value of enum vsf_adc_irq_mask_t, vsf_adc_irq_mask_t

Returns

none.

vsf_adc_irq_enable()

void vsf_adc_irq_enable	(	vsf_adc_t *	adc_ptr,
		vsf_adc_irq_mask_t	irq_mask
	)

enable interrupt masks of adc instance.

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	irq_mask	one or more value of enum vsf_adc_irq_mask_t

Returns

none.

Note

All pending interrupts should be cleared before interrupts are enabled.

vsf_adc_irq_disable()

void vsf_adc_irq_disable	(	vsf_adc_t *	adc_ptr,
		vsf_adc_irq_mask_t	irq_mask
	)

disable interrupt masks of adc instance.

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	irq_mask	one or more value of enum vsf_adc_irq_mask_t, vsf_adc_irq_mask_t

Returns

none.

vsf_adc_status()

vsf_adc_status_t vsf_adc_status

(

vsf_adc_t *

adc_ptr

)

get the status of adc instance.

Parameters

[in]

adc_ptr

a pointer to structure vsf_adc_t

Returns

vsf_adc_status_t: return all status of current adc

vsf_adc_capability()

vsf_adc_capability_t vsf_adc_capability

(

vsf_adc_t *

adc_ptr

)

get the capability of adc instance.

Parameters

[in]

adc_ptr

a pointer to structure vsf_adc_t

Returns

vsf_adc_capability_t: return all capability of current adc vsf_adc_capability_t

vsf_adc_channel_request_once()

vsf_err_t vsf_adc_channel_request_once	(	vsf_adc_t *	adc_ptr,
		vsf_adc_channel_cfg_t *	channel_cfg,
		void *	buffer_ptr
	)

adc request sampling once

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	channel_cfg	a pointer to sampling channel configuration
[in]	buffer_ptr	data buffer

Returns

vsf_err_t: VSF_ERR_NONE if the adc request was successfully, or a negative error code

vsf_adc_channel_config()

vsf_err_t vsf_adc_channel_config	(	vsf_adc_t *	adc_ptr,
		vsf_adc_channel_cfg_t *	channel_cfgs_ptr,
		uint32_t	channel_cfgs_cnt
	)

adc channel configuration

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[in]	channel_cfgs_ptr	sampling channel configuration array
[in]	channel_cfgs_ptr	the length of sampling channel configuration array
[in]	buffer_ptr	data buffer

Returns

vsf_err_t: VSF_ERR_NONE if the adc request was successfully, or a negative error code

vsf_adc_channel_request()

vsf_err_t vsf_adc_channel_request	(	vsf_adc_t *	adc_ptr,
		void *	buffer_ptr,
		uint_fast32_t	count
	)

adc channel request

Parameters

[in]	adc_ptr	a pointer to structure vsf_adc_t
[out]	buffer_ptr	sampling channel data array
[in]	count	the length of sampling channel configuration data array

Returns

vsf_err_t: VSF_ERR_NONE if the adc request was successfully, or a negative error code