adc.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/common/template/vsf_template_hal_driver.h"
#include "../../__device.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_adc_status_t
	Predefined VSF ADC status that can be reimplemented in specific HAL drivers. More...
struct	vsf_adc_isr_t
	adc isr for api More...
struct	vsf_adc_cfg_t
	Configuration structure for ADC. More...
struct	vsf_adc_capability_t
	Predefined VSF ADC capability that can be reimplemented in specific HAL drivers. More...

Macros
#define	__HAL_DRIVER_   ${SERIES/ADC_IP}_ADC_H__
#define	VSF_   ${ADC_IP}_ADC_CFG_MULTI_CLASS VSF_ADC_CFG_MULTI_CLASS
#define	VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE   ENABLED
#define	VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED
#define	VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedefs
typedef enum vsf_adc_mode_t	vsf_adc_mode_t
typedef enum vsf_adc_irq_mask_t	vsf_adc_irq_mask_t
typedef struct vsf_adc_status_t	vsf_adc_status_t
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
typedef struct vsf_adc_capability_t	vsf_adc_capability_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_irq_mask_t { VSF_ADC_IRQ_MASK_CPL = (0x1ul << 0) }

Variables
class vsf_$ *	reg
vsf_adc_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/ADC_IP}_ADC_H__

VSF_

#define VSF_   ${ADC_IP}_ADC_CFG_MULTI_CLASS VSF_ADC_CFG_MULTI_CLASS

Note

When vsf_peripheral_status_t is inherited, vsf_template_hal_driver.h needs to be included

VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE   ENABLED

VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_adc_mode_t

typedef enum vsf_adc_mode_t vsf_adc_mode_t

vsf_adc_irq_mask_t

typedef enum vsf_adc_irq_mask_t vsf_adc_irq_mask_t

vsf_adc_status_t

typedef struct vsf_adc_status_t vsf_adc_status_t

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

vsf_adc_capability_t

typedef struct vsf_adc_capability_t vsf_adc_capability_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
VSF_ADC_DATA_ALIGN_LEFT
VSF_ADC_SCAN_CONV_SINGLE_MODE
VSF_ADC_SCAN_CONV_SEQUENCE_MODE
VSF_ADC_EXTERN_TRIGGER_0
VSF_ADC_EXTERN_TRIGGER_1
VSF_ADC_EXTERN_TRIGGER_2

vsf_adc_irq_mask_t

enum vsf_adc_irq_mask_t

Enumerator
VSF_ADC_IRQ_MASK_CPL

Variable Documentation

reg

class vsf_$* reg

isr

vsf_adc_isr_t isr