VSF Documented
Data Structures | Macros | Typedefs | Enumerations | Functions
vsf_template_adc.h File Reference
#include "./vsf_template_hal_driver.h"
#include "hal/arch/vsf_arch.h"

Go to the source code of this file.

Data Structures

struct  vsf_adc_channel_cfg_t
 adc channel configuration More...
 
struct  vsf_adc_isr_t
 
struct  vsf_adc_cfg_t
 adc configuration More...
 
struct  vsf_adc_status_t
 
struct  vsf_adc_capability_t
 
struct  vsf_adc_op_t
 
struct  vsf_adc_t
 

Macros

#define VSF_ADC_CFG_MULTI_CLASS   ENABLED
 
#define VSF_ADC_CFG_PREFIX   vsf
 
#define VSF_ADC_CFG_FUNCTION_RENAME   ENABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE   DISABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   DISABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   DISABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   DISABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG   DISABLED
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY   DISABLED
 
#define VSF_ADC_CFG_INHERT_HAL_CAPABILITY   ENABLED
 
#define VSF_ADC_APIS(__PREFIX_NAME)
 
#define __VSF_HAL_TEMPLATE_API   VSF_HAL_TEMPLATE_API_FP
 
#define __vsf_adc_t   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_t)
 
#define vsf_adc_init(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_init) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 
#define vsf_adc_fini(__ADC)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_fini) ((__vsf_adc_t *)(__ADC))
 
#define vsf_adc_enable(__ADC)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_enable) ((__vsf_adc_t *)(__ADC))
 
#define vsf_adc_disable(__ADC)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_disable) ((__vsf_adc_t *)(__ADC))
 
#define vsf_adc_status(__ADC)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_status) ((__vsf_adc_t *)(__ADC))
 
#define vsf_adc_capability(__ADC)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_capability) ((__vsf_adc_t *)(__ADC))
 
#define vsf_adc_irq_enable(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_enable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 
#define vsf_adc_irq_disable(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_disable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 
#define vsf_adc_channel_request_once(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request_once) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 
#define vsf_adc_channel_config(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_config) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 
#define vsf_adc_channel_request(__ADC, ...)   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
 

Typedefs

typedef enum vsf_adc_mode_t vsf_adc_mode_t
 
typedef enum vsf_adc_channel_mode_t vsf_adc_channel_mode_t
 
typedef enum vsf_adc_irq_mask_t vsf_adc_irq_mask_t
 
typedef struct vsf_adc_channel_cfg_t vsf_adc_channel_cfg_t
 adc channel configuration
 
typedef struct vsf_adc_t vsf_adc_t
 
typedef void vsf_adc_isr_handler_t(void *target_ptr, vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
 
typedef struct vsf_adc_isr_t vsf_adc_isr_t
 
typedef struct vsf_adc_cfg_t vsf_adc_cfg_t
 adc configuration
 
typedef struct vsf_adc_status_t vsf_adc_status_t
 
typedef struct vsf_adc_capability_t vsf_adc_capability_t
 
typedef struct vsf_adc_op_t vsf_adc_op_t
 

Enumerations

enum  vsf_adc_mode_t {
  VSF_ADC_REF_VDD_1 = (0 << 0) ,
  VSF_ADC_REF_VDD_1_2 = (1 << 0) ,
  VSF_ADC_REF_VDD_1_3 = (2 << 0) ,
  VSF_ADC_REF_VDD_1_4 = (3 << 0) ,
  VSF_ADC_DATA_ALIGN_RIGHT = (0 << 2) ,
  VSF_ADC_DATA_ALIGN_LEFT = (1 << 2) ,
  VSF_ADC_SCAN_CONV_SINGLE_MODE = (0 << 3) ,
  VSF_ADC_SCAN_CONV_SEQUENCE_MODE = (1 << 3) ,
  VSF_ADC_EXTERN_TRIGGER_0 = (0 << 4) ,
  VSF_ADC_EXTERN_TRIGGER_1 = (1 << 4) ,
  VSF_ADC_EXTERN_TRIGGER_2 = (2 << 4)
}
 
enum  {
  VSF_ADC_REF_VDD_COUNT = 4 ,
  VSF_ADC_REF_VDD_MASK ,
  VSF_ADC_DATA_ALIGN_COUNT = 2 ,
  VSF_ADC_DATA_ALIGN_MASK ,
  VSF_ADC_SCAN_CONV_COUNT = 2 ,
  VSF_ADC_SCAN_CONV_MASK ,
  VSF_ADC_EXTERN_TRIGGER_COUNT = 3 ,
  VSF_ADC_EXTERN_TRIGGER_MASK ,
  VSF_ADC_MODE_MASK_COUNT = 4 ,
  VSF_ADC_MODE_ALL_BITS_MASK
}
 
enum  vsf_adc_channel_mode_t {
  VSF_ADC_CHANNEL_GAIN_1_6 = (0 << 0) ,
  VSF_ADC_CHANNEL_GAIN_1_5 = (1 << 0) ,
  VSF_ADC_CHANNEL_GAIN_1_4 = (2 << 0) ,
  VSF_ADC_CHANNEL_GAIN_1_3 = (3 << 0) ,
  VSF_ADC_CHANNEL_GAIN_1_2 = (4 << 0) ,
  VSF_ADC_CHANNEL_GAIN_1 = (5 << 0) ,
  VSF_ADC_CHANNEL_REF_VDD_1 = (0 << 4) ,
  VSF_ADC_CHANNEL_REF_VDD_1_2 = (1 << 4) ,
  VSF_ADC_CHANNEL_REF_VDD_1_3 = (2 << 4) ,
  VSF_ADC_CHANNEL_REF_VDD_1_4 = (3 << 4)
}
 
enum  {
  VSF_ADC_CHANNEL_GAIN_COUNT = 6 ,
  VSF_ADC_CHANNEL_GAIN_MASK ,
  VSF_ADC_CHANNEL_REF_VDD_COUNT = 4 ,
  VSF_ADC_CHANNEL_REF_VDD_MASK ,
  VSF_ADC_CHANNEL_MODE_MASK_COUNT = 2 ,
  VSF_ADC_CHANNEL_MODE_ALL_BITS_MASK
}
 
enum  vsf_adc_irq_mask_t { VSF_ADC_IRQ_MASK_CPL = (0x1ul << 0) }
 
enum  {
  VSF_ADC_IRQ_COUNT = 1 ,
  VSF_ADC_IRQ_ALL_BITS_MASK = VSF_ADC_IRQ_MASK_CPL
}
 

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_MULTI_CLASS

#define VSF_ADC_CFG_MULTI_CLASS   ENABLED

◆ VSF_ADC_CFG_PREFIX

#define VSF_ADC_CFG_PREFIX   vsf

◆ VSF_ADC_CFG_FUNCTION_RENAME

#define VSF_ADC_CFG_FUNCTION_RENAME   ENABLED

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE   DISABLED

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   DISABLED

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   DISABLED

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   DISABLED

Redefine struct vsf_adc_channel_cfg_t. For compatibility, members should not be deleted when struct vsf_adc_channel_cfg_t redefining.

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG   DISABLED

Redefine struct vsf_adc_cfg_t. The vsf_adc_isr_handler_t type also needs to be redefined For compatibility, members should not be deleted when struct vsf_adc_cfg_t redefining.

◆ VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY   DISABLED

Redefine struct vsf_adc_capability_t. For compatibility, members should not be deleted when struct vsf_adc_capability_t redefining.

◆ VSF_ADC_CFG_INHERT_HAL_CAPABILITY

#define VSF_ADC_CFG_INHERT_HAL_CAPABILITY   ENABLED

◆ VSF_ADC_APIS

#define VSF_ADC_APIS (   __PREFIX_NAME)
Value:
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, init, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_cfg_t *cfg_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, fini, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t, adc, enable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t, adc, disable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_adc_status_t, adc, status, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_adc_capability_t, adc, capability, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, irq_enable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_irq_mask_t irq_mask) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, irq_disable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_irq_mask_t irq_mask) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_request_once, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_channel_cfg_t *channel_cfg, void *buffer_ptr) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_config, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_channel_cfg_t *channel_cfgs_ptr, uint32_t channel_cfgs_cnt) \
__VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_request, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, void *buffer_ptr, uint_fast32_t count)
vsf_err_t
vsf_err_t
Definition __type.h:42
VSF_MCONNECT
struct VSF_MCONNECT(VSF_FLASH_CFG_IMP_PREFIX, _flash_t)
Definition flash.c:53
capability
__le16 capability
Definition ieee80211.h:134
irq_mask
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint_fast32_t
unsigned int uint_fast32_t
Definition stdint.h:27
vsf_adc_capability_t
Definition vsf_template_adc.h:248
vsf_adc_cfg_t
adc configuration
Definition vsf_template_adc.h:229
vsf_adc_channel_cfg_t
adc channel configuration
Definition vsf_template_adc.h:211
vsf_adc_status_t
Definition vsf_template_adc.h:237
fsm_rt_t
fsm_rt_t
Definition vsf_fsm.h:315
__VSF_HAL_TEMPLATE_API
#define __VSF_HAL_TEMPLATE_API
Definition vsf_template_adc.h:261
vsf_adc_irq_mask_t
vsf_adc_irq_mask_t
Definition vsf_template_adc.h:199
status
uint8_t status
Definition vsf_tgui.h:144

◆ __VSF_HAL_TEMPLATE_API

#define __VSF_HAL_TEMPLATE_API   VSF_HAL_TEMPLATE_API_FP

◆ __vsf_adc_t

#define __vsf_adc_t   VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_t)

◆ vsf_adc_init

#define vsf_adc_init (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_init) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

◆ vsf_adc_fini

#define vsf_adc_fini (   __ADC)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_fini) ((__vsf_adc_t *)(__ADC))

◆ vsf_adc_enable

#define vsf_adc_enable (   __ADC)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_enable) ((__vsf_adc_t *)(__ADC))

◆ vsf_adc_disable

#define vsf_adc_disable (   __ADC)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_disable) ((__vsf_adc_t *)(__ADC))

◆ vsf_adc_status

#define vsf_adc_status (   __ADC)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_status) ((__vsf_adc_t *)(__ADC))

◆ vsf_adc_capability

#define vsf_adc_capability (   __ADC)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_capability) ((__vsf_adc_t *)(__ADC))

◆ vsf_adc_irq_enable

#define vsf_adc_irq_enable (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_enable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

◆ vsf_adc_irq_disable

#define vsf_adc_irq_disable (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_disable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

◆ vsf_adc_channel_request_once

#define vsf_adc_channel_request_once (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request_once) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

◆ vsf_adc_channel_config

#define vsf_adc_channel_config (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_config) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

◆ vsf_adc_channel_request

#define vsf_adc_channel_request (   __ADC,
  ... 
)    VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)

Typedef Documentation

◆ vsf_adc_mode_t

typedef enum vsf_adc_mode_t vsf_adc_mode_t

◆ vsf_adc_channel_mode_t

typedef enum vsf_adc_channel_mode_t vsf_adc_channel_mode_t

◆ vsf_adc_irq_mask_t

typedef enum vsf_adc_irq_mask_t vsf_adc_irq_mask_t

◆ vsf_adc_channel_cfg_t

typedef struct vsf_adc_channel_cfg_t vsf_adc_channel_cfg_t

adc channel configuration

◆ vsf_adc_t

typedef struct vsf_adc_t vsf_adc_t

◆ vsf_adc_isr_handler_t

typedef void vsf_adc_isr_handler_t(void *target_ptr, vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)

◆ vsf_adc_isr_t

typedef struct vsf_adc_isr_t vsf_adc_isr_t

◆ vsf_adc_cfg_t

typedef struct vsf_adc_cfg_t vsf_adc_cfg_t

adc configuration

◆ vsf_adc_status_t

typedef struct vsf_adc_status_t vsf_adc_status_t

◆ vsf_adc_capability_t

typedef struct vsf_adc_capability_t vsf_adc_capability_t

◆ vsf_adc_op_t

typedef struct vsf_adc_op_t vsf_adc_op_t

Enumeration Type Documentation

◆ vsf_adc_mode_t

enum vsf_adc_mode_t
Enumerator
VSF_ADC_REF_VDD_1 
VSF_ADC_REF_VDD_1_2 
VSF_ADC_REF_VDD_1_3 
VSF_ADC_REF_VDD_1_4 
VSF_ADC_DATA_ALIGN_RIGHT 

ADC data alignment to right.

VSF_ADC_DATA_ALIGN_LEFT 

ADC data alignment to left.

VSF_ADC_SCAN_CONV_SINGLE_MODE 

Conversion is performed in single mode.

VSF_ADC_SCAN_CONV_SEQUENCE_MODE 

Conversions are performed in sequence mode.

VSF_ADC_EXTERN_TRIGGER_0 

Selects the external event used to trigger the conversion.

VSF_ADC_EXTERN_TRIGGER_1 
VSF_ADC_EXTERN_TRIGGER_2 

◆ anonymous enum

anonymous enum
Enumerator
VSF_ADC_REF_VDD_COUNT 
VSF_ADC_REF_VDD_MASK 
VSF_ADC_DATA_ALIGN_COUNT 
VSF_ADC_DATA_ALIGN_MASK 
VSF_ADC_SCAN_CONV_COUNT 
VSF_ADC_SCAN_CONV_MASK 
VSF_ADC_EXTERN_TRIGGER_COUNT 
VSF_ADC_EXTERN_TRIGGER_MASK 
VSF_ADC_MODE_MASK_COUNT 
VSF_ADC_MODE_ALL_BITS_MASK 

◆ vsf_adc_channel_mode_t

enum vsf_adc_channel_mode_t
Enumerator
VSF_ADC_CHANNEL_GAIN_1_6 
VSF_ADC_CHANNEL_GAIN_1_5 
VSF_ADC_CHANNEL_GAIN_1_4 
VSF_ADC_CHANNEL_GAIN_1_3 
VSF_ADC_CHANNEL_GAIN_1_2 
VSF_ADC_CHANNEL_GAIN_1 
VSF_ADC_CHANNEL_REF_VDD_1 
VSF_ADC_CHANNEL_REF_VDD_1_2 
VSF_ADC_CHANNEL_REF_VDD_1_3 
VSF_ADC_CHANNEL_REF_VDD_1_4 

◆ anonymous enum

anonymous enum
Enumerator
VSF_ADC_CHANNEL_GAIN_COUNT 
VSF_ADC_CHANNEL_GAIN_MASK 
VSF_ADC_CHANNEL_REF_VDD_COUNT 
VSF_ADC_CHANNEL_REF_VDD_MASK 
VSF_ADC_CHANNEL_MODE_MASK_COUNT 
VSF_ADC_CHANNEL_MODE_ALL_BITS_MASK 

◆ vsf_adc_irq_mask_t

enum vsf_adc_irq_mask_t
Enumerator
VSF_ADC_IRQ_MASK_CPL 

◆ anonymous enum

anonymous enum
Enumerator
VSF_ADC_IRQ_COUNT 
VSF_ADC_IRQ_ALL_BITS_MASK 

Function Documentation

◆ vsf_adc_init()

vsf_err_t vsf_adc_init ( vsf_adc_t *  adc_ptr,
vsf_adc_cfg_t *  cfg_ptr 
)
extern

initialize a adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]cfg_ptra 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)
extern

finalize a adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
Returns
none

◆ vsf_adc_enable()

fsm_rt_t vsf_adc_enable ( vsf_adc_t *  adc_ptr)
extern

enable interrupt masks of adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]irq_maskone 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)
extern

disable interrupt masks of adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]irq_maskone 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 
)
extern

enable interrupt masks of adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]irq_maskone 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 
)
extern

disable interrupt masks of adc instance.

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]irq_maskone 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)
extern

get the status of adc instance.

Parameters
[in]adc_ptra 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)
extern

get the capability of adc instance.

Parameters
[in]adc_ptra 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 
)
extern

adc request sampling once

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]channel_cfga pointer to sampling channel configuration
[in]buffer_ptrdata 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 
)
extern

adc channel configuration

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[in]channel_cfgs_ptrsampling channel configuration array
[in]channel_cfgs_ptrthe length of sampling channel configuration array
[in]buffer_ptrdata 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 
)
extern

adc channel request

Parameters
[in]adc_ptra pointer to structure vsf_adc_t
[out]buffer_ptrsampling channel data array
[in]countthe 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
Generated by doxygen 1.9.8