dac_common.c File Reference

#include "hal/driver/driver.h"

Macros
#define	VSF_DAC_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_dac_init (vsf_dac_t *dac_ptr, vsf_dac_cfg_t *cfg_ptr)
	Initialize a DAC instance.
void	vsf_dac_fini (vsf_dac_t *dac_ptr)
	Finalize a DAC instance.
vsf_err_t	vsf_dac_get_configuration (vsf_dac_t *dac_ptr, vsf_dac_cfg_t *cfg_ptr)
	Get current configuration of a DAC instance.
fsm_rt_t	vsf_dac_enable (vsf_dac_t *dac_ptr)
	Enable a DAC instance.
fsm_rt_t	vsf_dac_disable (vsf_dac_t *dac_ptr)
	Disable a DAC instance.
void	vsf_dac_irq_enable (vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask)
	Enable interrupt masks of DAC instance.
void	vsf_dac_irq_disable (vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask)
	Disable interrupt masks of DAC instance.
vsf_dac_status_t	vsf_dac_status (vsf_dac_t *dac_ptr)
	Get the status of DAC instance.
vsf_dac_capability_t	vsf_dac_capability (vsf_dac_t *dac_ptr)
	Get the capability of DAC instance.
vsf_err_t	vsf_dac_channel_request_once (vsf_dac_t *dac_ptr, vsf_dac_channel_cfg_t *channel_cfg, uint_fast16_t value)
	DAC request convert once.
vsf_err_t	vsf_dac_channel_config (vsf_dac_t *dac_ptr, vsf_dac_channel_cfg_t *channel_cfgs_ptr, uint_fast8_t channel_cfgs_cnt)
	DAC channel configuration.
vsf_err_t	vsf_dac_channel_request (vsf_dac_t *dac_ptr, void *buffer_ptr, uint_fast32_t count)
	DAC channel request.

Macro Definition Documentation

VSF_DAC_CFG_FUNCTION_RENAME

#define VSF_DAC_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_dac_init()

vsf_err_t vsf_dac_init	(	vsf_dac_t *	dac_ptr,
		vsf_dac_cfg_t *	cfg_ptr
	)

Initialize a DAC instance.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[in]	cfg_ptr	a pointer to structure vsf_dac_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if the initialization was successful, otherwise returns error code

Note

It is not necessary to call vsf_dac_fini() to deinitialize. vsf_dac_init() should be called before any other DAC API except vsf_dac_capability().

vsf_dac_fini()

void vsf_dac_fini

(

vsf_dac_t *

dac_ptr

)

Finalize a DAC instance.

Parameters

[in]

dac_ptr

a pointer to structure vsf_dac_t

Returns

none

vsf_dac_get_configuration()

vsf_err_t vsf_dac_get_configuration	(	vsf_dac_t *	dac_ptr,
		vsf_dac_cfg_t *	cfg_ptr
	)

Get current configuration of a DAC instance.

Parameters

[in]	dac_ptr	Pointer to DAC instance
[out]	cfg_ptr	Pointer to DAC configuration structure to store current settings

Returns

vsf_err_t VSF_ERR_NONE if successful, otherwise an error code

Note

This function retrieves the current configuration of the DAC instance

vsf_dac_enable()

fsm_rt_t vsf_dac_enable

(

vsf_dac_t *

dac_ptr

)

Enable a DAC instance.

Parameters

[in]

dac_ptr

a pointer to structure vsf_dac_t

Returns

fsm_rt_t: fsm_rt_cpl if DAC was enabled, fsm_rt_on_going if DAC is still enabling

vsf_dac_disable()

fsm_rt_t vsf_dac_disable

(

vsf_dac_t *

dac_ptr

)

Disable a DAC instance.

Parameters

[in]

dac_ptr

a pointer to structure vsf_dac_t

Returns

fsm_rt_t: fsm_rt_cpl if DAC was disabled, fsm_rt_on_going if DAC is still disabling

vsf_dac_irq_enable()

void vsf_dac_irq_enable	(	vsf_dac_t *	dac_ptr,
		vsf_dac_irq_mask_t	irq_mask
	)

Enable interrupt masks of DAC instance.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[in]	irq_mask	one or more value of enum vsf_dac_irq_mask_t, vsf_dac_irq_mask_t

Returns

none

Note

All pending interrupts should be cleared before interrupts are enabled

vsf_dac_irq_disable()

void vsf_dac_irq_disable	(	vsf_dac_t *	dac_ptr,
		vsf_dac_irq_mask_t	irq_mask
	)

Disable interrupt masks of DAC instance.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[in]	irq_mask	one or more value of enum vsf_dac_irq_mask_t, vsf_dac_irq_mask_t

Returns

none

vsf_dac_status()

vsf_dac_status_t vsf_dac_status

(

vsf_dac_t *

dac_ptr

)

Get the status of DAC instance.

Parameters

[in]

dac_ptr

a pointer to structure vsf_dac_t

Returns

vsf_dac_status_t: All status of current DAC

vsf_dac_capability()

vsf_dac_capability_t vsf_dac_capability

(

vsf_dac_t *

dac_ptr

)

Get the capability of DAC instance.

Parameters

[in]

dac_ptr

a pointer to structure vsf_dac_t

Returns

vsf_dac_capability_t: All capability of current DAC vsf_dac_capability_t

vsf_dac_channel_request_once()

vsf_err_t vsf_dac_channel_request_once	(	vsf_dac_t *	dac_ptr,
		vsf_dac_channel_cfg_t *	channel_cfg,
		uint_fast16_t	value
	)

DAC request convert once.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[in]	channel_cfg	a pointer to convert channel configuration
[in]	value	value to be converted

Returns

vsf_err_t: VSF_ERR_NONE if the request was successful, otherwise returns error code

vsf_dac_channel_config()

vsf_err_t vsf_dac_channel_config	(	vsf_dac_t *	dac_ptr,
		vsf_dac_channel_cfg_t *	cfgs_ptr,
		uint_fast8_t	cnt
	)

DAC channel configuration.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[in]	cfgs_ptr	convert channel configuration array
[in]	cnt	the length of convert channel configuration array

Returns

vsf_err_t: VSF_ERR_NONE if the configuration was successful, otherwise returns error code

vsf_dac_channel_request()

vsf_err_t vsf_dac_channel_request	(	vsf_dac_t *	dac_ptr,
		void *	buffer_ptr,
		uint_fast32_t	count
	)

DAC channel request.

Parameters

[in]	dac_ptr	a pointer to structure vsf_dac_t
[out]	buffer_ptr	convert channel data array
[in]	count	the length of convert channel configuration data array

Returns

vsf_err_t: VSF_ERR_NONE if the request was successful, otherwise returns error code