VSC driver APIs

VSC driver APIs. More...

Data Structures
struct	vsc_adc_config_t
	adc config structure More...
struct	vsc_data_opr_config_t
	vsc config structure More...
struct	vsc_config_t
	vsc config structure More...

Typedefs
typedef enum vsc_phase_mode	vsc_phase_mode_t
	vsc phase mode More...
typedef enum vsc_data_opr_mode	vsc_data_opr_mode_t
	vsc data operation mode More...
typedef enum vsc_adc_sel	vsc_adc_sel_t
	vsc select adc instance More...
typedef enum vsc_pos_cap_mode	vsc_pos_cap_mode_t
	vsc position capture mode More...
typedef enum vsc_timestamp_sel	vsc_timestamp_sel_t
	vsc select adc timestamp More...
typedef enum vsc_irq_mask	vsc_irq_mask_t
	vsc irq mask bit More...

Enumerations
enum	vsc_phase_mode { vsc_abc_phase = 0 , vsc_ab_phase = 1 }
	vsc phase mode More...
enum	vsc_data_opr_mode {   vsc_data_opr_plus_mul_1 = 0 , vsc_data_opr_plus_mul_2 = 1 , vsc_data_opr_plus_div_2 = 5 , vsc_data_opr_plus_div_3 = 6 ,   vsc_data_opr_plus_div_4 = 7 , vsc_data_opr_minus_mul_1 = 8 , vsc_data_opr_minus_mul_2 = 9 , vsc_data_opr_minus_div_2 = 13 ,   vsc_data_opr_minus_div_3 = 14 , vsc_data_opr_minus_div_4 = 15 }
	vsc data operation mode More...
enum	vsc_adc_sel { vsc_sel_adc0 = 1 , vsc_sel_adc1 = 2 , vsc_sel_adc2 = 3 }
	vsc select adc instance More...
enum	vsc_pos_cap_mode { vsc_pos_use_last_data_when_adc_sample_finish = 0 , vsc_pos_use_first_data_after_adc_sample_start = 1 , vsc_pos_use_last_data_before_adc_sample_start = 2 }
	vsc position capture mode More...
enum	vsc_timestamp_sel { vsc_timestamp_sel_value_a = 1 , vsc_timestamp_sel_value_b = 2 , vsc_timestamp_sel_value_c = 3 }
	vsc select adc timestamp More...
enum	vsc_irq_mask {   vsc_irq_convert_done = (0x00000001UL) , vsc_irq_abc_over_tolerate = (0x00000002UL) , vsc_irq_c_overflow = (0x00000004UL) , vsc_irq_b_overflow = (0x00000008UL) ,   vsc_irq_a_overflow = (0x00000010UL) , vsc_irq_adc2_cap_not_enough = (0x00000020UL) , vsc_irq_adc1_cap_not_enough = (0x00000040UL) , vsc_irq_adc0_cap_not_enough = (0x00000080UL) ,   vsc_irq_pos_timeout = (0x00000100UL) , vsc_irq_adc2_timeout = (0x00000200UL) , vsc_irq_adc1_timeout = (0x00000400UL) , vsc_irq_adc0_timeout = (0x00000800UL) ,   vsc_irq_convert_conflict = (0x00001000UL) }
	vsc irq mask bit More...

Functions
static void	vsc_set_enable (VSC_Type *vsc, bool enable)
	vsc enable or disable More...
static void	vsc_config_pos_capture_mode (VSC_Type *vsc, vsc_pos_cap_mode_t mode)
	vsc config position capture mode More...
static void	vsc_config_adc_timestamp (VSC_Type *vsc, vsc_timestamp_sel_t select, uint8_t num)
	vsc config adc timestamp More...
static void	vsc_set_irq_enable (VSC_Type *vsc, uint32_t irq_mask, bool enable)
	vsc set irq enable or disable More...
static uint32_t	vsc_get_irq_status (VSC_Type *vsc)
	vsc get irq status More...
static void	vsc_clear_irq_status (VSC_Type *vsc, uint32_t irq_mask)
	vsc clear irq status More...
static bool	vsc_get_irq_flag (VSC_Type *vsc, uint32_t irq_mask)
	vsc check irq request flag More...
static void	vsc_set_adc_wait_cycle (VSC_Type *vsc, uint32_t wait_cycle)
	vsc set adc wait cycles More...
static void	vsc_set_pos_wait_cycle (VSC_Type *vsc, uint32_t wait_cycle)
	vsc set position wait cycles More...
static void	vsc_set_adc_tolerate (VSC_Type *vsc, uint32_t tolerate)
	vsc set abc phase value tolerate More...
static void	vsc_set_pos_pole_pairs (VSC_Type *vsc, uint32_t pole_pairs)
	vsc set position pole pairs More...
static void	vsc_set_sw_trig_in (VSC_Type *vsc)
	vsc set software trigger in More...
static int32_t	vsc_get_d_axis_value (VSC_Type *vsc, bool positive_seq)
	vsc get d-axis value More...
static int32_t	vsc_get_q_axis_value (VSC_Type *vsc, bool positive_seq)
	vsc get q-axis value More...
static int32_t	vsc_get_alpha_axis_value (VSC_Type *vsc, bool positive_seq)
	vsc get alpha-axis value More...
static int32_t	vsc_get_beta_axis_value (VSC_Type *vsc, bool positive_seq)
	vsc get beta-axis value More...
static uint32_t	vsc_get_adc_timestamp (VSC_Type *vsc)
	vsc get adc timestamp value More...
void	vsc_get_default_config (VSC_Type *vsc, vsc_config_t *config)
	vsc get default config More...
void	vsc_config_init (VSC_Type *vsc, vsc_config_t *config)
	vsc config initialization More...
void	vsc_sw_inject_abc_value (VSC_Type *vsc, int32_t value_a, int32_t value_b, int32_t value_c)
	vsc software inject phase a/b/c value More...
void	vsc_sw_inject_pos_value (VSC_Type *vsc, uint32_t pos)
	vsc software inject position value More...

Detailed Description

VSC driver APIs.

Typedef Documentation

vsc_adc_sel_t

typedef enum vsc_adc_sel vsc_adc_sel_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc select adc instance

vsc_adc_sel_t

vsc_data_opr_mode_t

typedef enum vsc_data_opr_mode vsc_data_opr_mode_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc data operation mode

vsc_data_opr_mode_t

vsc_irq_mask_t

typedef enum vsc_irq_mask vsc_irq_mask_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc irq mask bit

vsc_phase_mode_t

typedef enum vsc_phase_mode vsc_phase_mode_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc phase mode

vsc_phase_mode_t

vsc_pos_cap_mode_t

typedef enum vsc_pos_cap_mode vsc_pos_cap_mode_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc position capture mode

vsc_pos_cap_mode_t

vsc_timestamp_sel_t

typedef enum vsc_timestamp_sel vsc_timestamp_sel_t

#include <drivers/inc/hpm_vsc_drv.h>

vsc select adc timestamp

vsc_timestamp_sel_t

Enumeration Type Documentation

vsc_adc_sel

enum vsc_adc_sel

#include <drivers/inc/hpm_vsc_drv.h>

vsc select adc instance

Enumerator
vsc_sel_adc0
vsc_sel_adc1
vsc_sel_adc2

vsc_data_opr_mode

enum vsc_data_opr_mode

#include <drivers/inc/hpm_vsc_drv.h>

vsc data operation mode

Enumerator
vsc_data_opr_plus_mul_1
vsc_data_opr_plus_mul_2
vsc_data_opr_plus_div_2
vsc_data_opr_plus_div_3
vsc_data_opr_plus_div_4
vsc_data_opr_minus_mul_1
vsc_data_opr_minus_mul_2
vsc_data_opr_minus_div_2
vsc_data_opr_minus_div_3
vsc_data_opr_minus_div_4

vsc_irq_mask

enum vsc_irq_mask

#include <drivers/inc/hpm_vsc_drv.h>

vsc irq mask bit

Enumerator
vsc_irq_convert_done
vsc_irq_abc_over_tolerate
vsc_irq_c_overflow
vsc_irq_b_overflow
vsc_irq_a_overflow
vsc_irq_adc2_cap_not_enough
vsc_irq_adc1_cap_not_enough
vsc_irq_adc0_cap_not_enough
vsc_irq_pos_timeout
vsc_irq_adc2_timeout
vsc_irq_adc1_timeout
vsc_irq_adc0_timeout
vsc_irq_convert_conflict

vsc_phase_mode

enum vsc_phase_mode

#include <drivers/inc/hpm_vsc_drv.h>

vsc phase mode

Enumerator
vsc_abc_phase
vsc_ab_phase

vsc_pos_cap_mode

enum vsc_pos_cap_mode

#include <drivers/inc/hpm_vsc_drv.h>

vsc position capture mode

Enumerator
vsc_pos_use_last_data_when_adc_sample_finish
vsc_pos_use_first_data_after_adc_sample_start
vsc_pos_use_last_data_before_adc_sample_start

vsc_timestamp_sel

enum vsc_timestamp_sel

#include <drivers/inc/hpm_vsc_drv.h>

vsc select adc timestamp

Enumerator
vsc_timestamp_sel_value_a
vsc_timestamp_sel_value_b
vsc_timestamp_sel_value_c

Function Documentation

vsc_clear_irq_status()

static void vsc_clear_irq_status ( VSC_Type *  vsc, uint32_t  irq_mask  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc clear irq status

Parameters

[in]	vsc	CLC base address
[in]	irq_mask	irq mask, vsc_irq_mask_t

vsc_config_adc_timestamp()

static void vsc_config_adc_timestamp ( VSC_Type *  vsc, vsc_timestamp_sel_t  select, uint8_t  num  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc config adc timestamp

Parameters

[in]	vsc	VSC base address
[in]	select	timestamp select from value a/b/c. vsc_timestamp_sel_t
[in]	num	timestamp use which number index of vsc_timestamp_sel_t used.

vsc_config_init()

void vsc_config_init	(	VSC_Type *	vsc,
		vsc_config_t *	config
	)

#include <drivers/inc/hpm_vsc_drv.h>

vsc config initialization

Parameters

[in]	vsc	VSC base address
[in]	config	vsc config struct

vsc_config_pos_capture_mode()

static void vsc_config_pos_capture_mode ( VSC_Type *  vsc, vsc_pos_cap_mode_t  mode  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc config position capture mode

Parameters

[in]	vsc	VSC base address
[in]	mode	vsc_pos_cap_mode_t

vsc_get_adc_timestamp()

static uint32_t vsc_get_adc_timestamp ( VSC_Type *  vsc )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get adc timestamp value

Parameters

[in]

vsc

CLC base address

Return values

adc	timestamp value

vsc_get_alpha_axis_value()

static int32_t vsc_get_alpha_axis_value ( VSC_Type *  vsc, bool  positive_seq  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get alpha-axis value

Parameters

[in]	vsc	CLC base address
[in]	positive_seq	true - positive order; false - reverse order

Return values

alpha-axis

value

vsc_get_beta_axis_value()

static int32_t vsc_get_beta_axis_value ( VSC_Type *  vsc, bool  positive_seq  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get beta-axis value

Parameters

[in]	vsc	CLC base address
[in]	positive_seq	true - positive order; false - reverse order

Return values

beta-axis

value

vsc_get_d_axis_value()

static int32_t vsc_get_d_axis_value ( VSC_Type *  vsc, bool  positive_seq  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get d-axis value

Parameters

[in]	vsc	CLC base address
[in]	positive_seq	true - positive order; false - reverse order

Return values

d-axis

value

vsc_get_default_config()

void vsc_get_default_config	(	VSC_Type *	vsc,
		vsc_config_t *	config
	)

#include <drivers/inc/hpm_vsc_drv.h>

vsc get default config

Parameters

[in]	vsc	VSC base address
[out]	config	vsc default config

vsc_get_irq_flag()

static bool vsc_get_irq_flag ( VSC_Type *  vsc, uint32_t  irq_mask  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc check irq request flag

Parameters

[in]	vsc	CLC base address
[in]	irq_mask	irq mask, vsc_irq_mask_t

Return values

true-has

irq req, false-no irq req.

vsc_get_irq_status()

static uint32_t vsc_get_irq_status ( VSC_Type *  vsc )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get irq status

Parameters

[in]

vsc

CLC base address

Return values

irq

status.

vsc_get_q_axis_value()

static int32_t vsc_get_q_axis_value ( VSC_Type *  vsc, bool  positive_seq  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc get q-axis value

Parameters

[in]	vsc	CLC base address
[in]	positive_seq	true - positive order; false - reverse order

Return values

q-axis

value

vsc_set_adc_tolerate()

static void vsc_set_adc_tolerate ( VSC_Type *  vsc, uint32_t  tolerate  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set abc phase value tolerate

Parameters

[in]	vsc	CLC base address
[in]	tolerate	value a/b/c total value tolerate

vsc_set_adc_wait_cycle()

static void vsc_set_adc_wait_cycle ( VSC_Type *  vsc, uint32_t  wait_cycle  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set adc wait cycles

Parameters

[in]	vsc	CLC base address
[in]	wait_cycle	adc wait cycle for exception

vsc_set_enable()

static void vsc_set_enable ( VSC_Type *  vsc, bool  enable  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc enable or disable

Parameters

[in]	vsc	VSC base address
[in]	enable	true-enable, false-disable

vsc_set_irq_enable()

static void vsc_set_irq_enable ( VSC_Type *  vsc, uint32_t  irq_mask, bool  enable  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set irq enable or disable

Parameters

[in]	vsc	CLC base address
[in]	irq_mask	irq mask, vsc_irq_mask_t
[in]	enable	enable or disable true enable false disable

vsc_set_pos_pole_pairs()

static void vsc_set_pos_pole_pairs ( VSC_Type *  vsc, uint32_t  pole_pairs  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set position pole pairs

Parameters

[in]	vsc	CLC base address
[in]	pole_pairs	pole pairs number

vsc_set_pos_wait_cycle()

static void vsc_set_pos_wait_cycle ( VSC_Type *  vsc, uint32_t  wait_cycle  )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set position wait cycles

Parameters

[in]	vsc	CLC base address
[in]	wait_cycle	position wait cycle for exception

vsc_set_sw_trig_in()

static void vsc_set_sw_trig_in ( VSC_Type *  vsc )

inlinestatic

#include <drivers/inc/hpm_vsc_drv.h>

vsc set software trigger in

Parameters

[in]

vsc

CLC base address

vsc_sw_inject_abc_value()

void vsc_sw_inject_abc_value	(	VSC_Type *	vsc,
		int32_t	value_a,
		int32_t	value_b,
		int32_t	value_c
	)

#include <drivers/inc/hpm_vsc_drv.h>

vsc software inject phase a/b/c value

Parameters

[in]	vsc	VSC base address
[in]	value_a	phase a value
[in]	value_b	phase b value
[in]	value_c	phase c value

vsc_sw_inject_pos_value()

void vsc_sw_inject_pos_value	(	VSC_Type *	vsc,
		uint32_t	pos
	)

#include <drivers/inc/hpm_vsc_drv.h>

vsc software inject position value

Parameters

[in]	vsc	VSC base address
[in]	pos	position value