Video and Vision Processing Suite Intel® FPGA IP User Guide

ID 683329
Date 12/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
1. About the Video and Vision Processing Suite 2. Getting Started with the Video and Vision Processing IPs 3. Video and Vision Processing IPs Functional Description 4. Video and Vision Processing IP Interfaces 5. Video and Vision Processing IP Registers 6. Video and Vision Processing IPs Software Programming Model 7. Protocol Converter Intel® FPGA IP 8. 1D LUT Intel® FPGA IP 9. 3D LUT Intel® FPGA IP 10. AXI-Stream Broadcaster Intel® FPGA IP 11. Bits per Color Sample Adapter Intel FPGA IP 12. Black Level Correction Intel® FPGA IP 13. Black Level Statistics Intel® FPGA IP 14. Chroma Key Intel® FPGA IP 15. Chroma Resampler Intel® FPGA IP 16. Clipper Intel® FPGA IP 17. Clocked Video Input Intel® FPGA IP 18. Clocked Video to Full-Raster Converter Intel® FPGA IP 19. Clocked Video Output Intel® FPGA IP 20. Color Space Converter Intel® FPGA IP 21. Defective Pixel Correction Intel® FPGA IP 22. Deinterlacer Intel® FPGA IP 23. Demosaic Intel® FPGA IP 24. FIR Filter Intel® FPGA IP 25. Frame Cleaner Intel® FPGA IP 26. Full-Raster to Clocked Video Converter Intel® FPGA IP 27. Full-Raster to Streaming Converter Intel® FPGA IP 28. Genlock Controller Intel® FPGA IP 29. Generic Crosspoint Intel® FPGA IP 30. Genlock Signal Router Intel® FPGA IP 31. Guard Bands Intel® FPGA IP 32. Histogram Statistics Intel® FPGA IP 33. Interlacer Intel® FPGA IP 34. Mixer Intel® FPGA IP 35. Pixels in Parallel Converter Intel® FPGA IP 36. Scaler Intel® FPGA IP 37. Stream Cleaner Intel® FPGA IP 38. Switch Intel® FPGA IP 39. Tone Mapping Operator Intel® FPGA IP 40. Test Pattern Generator Intel® FPGA IP 41. Unsharp Mask Intel® FPGA IP 42. Video and Vision Monitor Intel FPGA IP 43. Video Frame Buffer Intel® FPGA IP 44. Video Frame Reader Intel FPGA IP 45. Video Frame Writer Intel FPGA IP 46. Video Streaming FIFO Intel® FPGA IP 47. Video Timing Generator Intel® FPGA IP 48. Vignette Correction Intel® FPGA IP 49. Warp Intel® FPGA IP 50. White Balance Correction Intel® FPGA IP 51. White Balance Statistics Intel® FPGA IP 52. Design Security 53. Document Revision History for Video and Vision Processing Suite User Guide

28.6. Genlock Controller IP Software API

The IP has a software driver for software control of the IP at run time. The IP does not fit any of the generic device models provided by the Nios II HAL. It exposes a set of dedicated accessors to the control and status registers. The driver structure inherits the base driver structure, so all common methods in Video and Vision Processing IPs Software API are applicable.

intel_vvp_genlock_controller_init

Prototype

uint32_t intel_vvp_genlock_controller_init (intel_vvp_genlock_controller_instance* instance, intel_vvp_core_base base);

Description

Initialization function for a VVP Genlock Controller instance.

Attempts to initialize the fields of the Genlock Controller and its base core

Arguments

instance, pointer to the intel_vvp_ genlock_controller _instance to initialize

base, the accessor for the core (on Nios this is a pointer to the base address of the core)

Returns

kIntelVvpCoreOk success

kIntelVvpCoreVidErr if the v kIntelVvpCoreVidErr if the vendor id of the core is not the IntelFPGA vendor ID.

kIntelVvpCorePidErr if the product id of the core is not the genlock_controller product id

kIntelVvpCoreInstanceErr if the instance parameter is zero (null pointer)

intel_vvp_genlock_controller_get_param_vid_pid

Prototype

uint32_t intel_vvp_genlock_controller_get_param_vid_pid (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The product ID number

intel_vvp_genlock_controller_get_param_version_number

Prototype

uint32_t intel_vvp_genlock_controller_get_param_version_number (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The IP version number value

intel_intel_vvp_genlock_controller_get_param_cpu_clk_freq_hz

Prototype

uint32_t intel_vvp_genlock_controller_get_param_cpu_clk_freq_hz (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The CPU frequency value in Hertz

intel_vvp_genlock_controller_get_param_num_ref_clks

Prototype

uint32_t intel_vvp_genlock_controller_get_param_num_ref_clks (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The maximum number of reference clock for VCXO tracking

intel_vvp_genlock_controller_get_param_err_val_bits

Prototype

uint32_t intel_vvp_genlock_controller_get_param_err_val_bits (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of bits to calculate an error value during a sampling period

intel_vvp_genlock_controller_get_param_clk_div_bits

Prototype

uint32_t intel_vvp_genlock_controller_get_param_clk_div_bits (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of bits to generate the PDF clock counter

intel_vvp_genlock_controller_get_param_err_update_bits

Prototype

uint32_t intel_vvp_genlock_controller_get_param_err_update_bits (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of bit to generate a PDF sampling window

intel_vvp_genlock_controller_get_param_dac_filter_lsb

Prototype

uint32_t intel_vvp_genlock_controller_get_param_dac_filter_lsb (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of LSBs to discard during the error calculation

intel_vvp_genlock_controller_get_param_dac_val_bits

Prototype

uint32_t intel_vvp_genlock_controller_get_param_dac_val_bits (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of bit to generate the DAC data output word.

intel_vvp_genlock_controller_get_param_dac_clk_div

Prototype

uint32_t intel_vvp_genlock_controller_get_param_dac_clk_div (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The clock divider factor to generate the PWM output pulse

intel_vvp_genlock_controller_get_param_derivative_en

Prototype

uint32_t intel_vvp_genlock_controller_get_param_derivative_en (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The status for the PID derivative term enable flag

intel_vvp_genlock_controller_get_param_lpf_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_param_lpf_mode (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The LPF mode value

intel_vvp_genlock_controller_get_param_i_gain_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_param_i_gain_mode (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integral gain mode value

intel_vvp_genlock_controller_get_param_p_gain_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_param_p_gain_mode (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The proportional gain mode value

intel_vvp_genlock_controller_get_param_d_gain_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_param_d_gain_mode (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The derivative gain mode value

intel_vvp_genlock_controller_get_param_lock_cnt_size

Prototype

uint32_t intel_vvp_genlock_controller_get_param_lock_cnt_size (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The number of bit to generate the lock status counter

intel_vvp_genlock_controller_get_param_enable_debug

Prototype

uint32_t intel_vvp_genlock_controller_get_param_enable_debug (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The debug mode value

intel_vvp_genlock_controller_is_rxtx_locked

Prototype

uint32_t intel_vvp_genlock_controller_is_rxtx_locked

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

1 if the bit is asserted, 0 otherwise

intel_vvp_genlock_controller_is_int_overflow

Prototype

uint32_t intel_vvp_genlock_controller_is_int_overflow

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

1 if the bit is asserted, 0 otherwise

intel_vvp_genlock_controller_is_dac_sat

Prototype

uint32_t intel_vvp_genlock_controller_is_dac_sat

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

1 if the bit is asserted, 0 otherwise

intel_vvp_genlock_controller_get_lpf_control_1_enable

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_enable

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF enable flag.

intel_vvp_genlock_controller_get_lpf_control_1_int_rst_dis

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_int_rst_dis

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF automatic reset flag.

intel_vvp_genlock_controller_get_lpf_control_1_lock_loss_conf_en

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_lock_loss_conf_en

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF lock loss confidence counter enable flag.

intel_vvp_genlock_controller_get_lpf_control_1_freq_lock_lsb

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_freq_lock_lsb

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the number of LSBs to ignore during the error calculation.

intel_vvp_genlock_controller_get_lpf_control_1_lock_status_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_lock_status_mode

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the LPF lock operation mode.

intel_vvp_genlock_controller_get_lpf_control_1_i_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_i_mode

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the LPF integral term operation mode.

intel_vvp_genlock_controller_get_lpf_control_1_p_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_p_mode

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the LPF proportional term operation mode.

intel_vvp_genlock_controller_get_lpf_control_1_d_mode

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_d_mode

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the LPF derivative term operation mode.

intel_vvp_genlock_controller_get_lpf_control_1_i_gain_sign_inv

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_i_gain_sign_inv

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF integral term sign flag.

intel_vvp_genlock_controller_get_lpf_control_1_p_gain_sign_inv

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_p_gain_sign_inv

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF proportional term sign flag.

intel_vvp_genlock_controller_get_lpf_control_1_d_gain_sign_inv

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_d_gain_sign_inv

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the LPF derivative term sign flag.

intel_vvp_genlock_controller_get_lpf_control_1_i_gain_frac

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_1_i_gain_frac

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC enable flag.

intel_vvp_genlock_controller_get_dac_control_op_en

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_op_en

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC enable flag.

intel_vvp_genlock_controller_get_dac_control_data_sel

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_data_sel

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC operation mode.

intel_vvp_genlock_controller_get_dac_control_hold

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_hold

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC hold flag.

intel_vvp_genlock_controller_get_dac_control_op_force_low

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_op_force_low

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC force-low flag.

intel_vvp_genlock_controller_get_dac_control_op_force_high

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_op_force_high

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC force-high flag.

intel_vvp_genlock_controller_get_dac_control_clk_div_disable

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_clk_div_disable

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the DAC clock divider flag.

intel_vvp_genlock_controller_get_dac_control_ob_cpu_value

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_control_ob_cpu_value

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the DAC offset value.

intel_vvp_genlock_controller_get_pfd_control_enable

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_control_enable

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the PFD enable flag.

intel_vvp_genlock_controller_get_pfd_control_ref_clk_sw_sel

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_control_ref_clk_sw_sel

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the value of the reference clock for VCXO tracking.

intel_vvp_genlock_controller_get_pfd_control_ref_clk_sw_rst

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_control_ref_clk_sw_rst

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the reset associated to each of the reference clocks.

intel_vvp_genlock_controller_get_pfd_control_vcxo_clk_sw_rst

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_control_vcxo_clk_sw_rst

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the reset associated to the VCXO clock.

intel_vvp_genlock_controller_get_pfd_control_update_cnt_msbs

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_control_update_cnt_msbs

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the value to update the update period counter.

intel_vvp_genlock_controller_get_stat_clk_run

Prototype

uint32_t intel_vvp_genlock_controller_get_stat_clk_run

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

If you assert a bit that indicates the reference clock associated to it is running.

intel_vvp_genlock_controller_get_stat_clk_stop

Prototype

uint32_t intel_vvp_genlock_controller_get_stat_clk_stop

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

If you assert a bit that indicates the reference clock associated to it is not running.

intel_vvp_genlock_controller_get_ref_clk_stop

Prototype

uint32_t intel_vvp_genlock_controller_get_ref_clk_stop

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the PID output block. If you assert this bit indicates that the PID is not updating this output value because of a reference clock not running.

intel_vvp_genlock_controller_get_pfd_overflow_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_overflow_val

(intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

the status of the error overflow flag.

intel_vvp_genlock_controller_get_lpf_control_2_int_rst_val

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_2_int_rst_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integral accumulator value at reset

intel_vvp_genlock_controller_get_lpf_control_3_i_gain

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_3_i_gain (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The gain to set the integral term for the PID controller

intel_vvp_genlock_controller_get_lpf_control_3_p_gain

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_3_p_gain (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The gain to set the proportional term for the PID controller

intel_vvp_genlock_controller_get_lpf_control_3_d_gain

Prototype

uint32_t intel_vvp_genlock_controller_get_lpf_control_3_d_gain (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

intel_vvp_genlock_controller_get_dac_status_val

Prototype

uint32_t intel_vvp_genlock_controller_get_dac_status_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The offset value output to the external VCXO

intel_vvp_genlock_controller_get_clk_dbg_status_1_val

Prototype

uint32_t intel_vvp_genlock_controller_get_clk_dbg_status_1_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The frequency value for VCXO clock

intel_vvp_genlock_controller_get_clk_dbg_status_2_val

Prototype

uint32_t intel_vvp_genlock_controller_get_clk_dbg_status_2_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The frequency value for reference clock 0

intel_vvp_genlock_controller_get_clk_dbg_status_3_val

Prototype

uint32_t intel_vvp_genlock_controller_get_clk_dbg_status_3_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The frequency value for reference clock 1

intel_vvp_genlock_controller_get_clk_dbg_status_4_val

Prototype

uint32_t intel_vvp_genlock_controller_get_clk_dbg_status_4_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The frequency value for reference clock 2

intel_vvp_genlock_controller_get_clk_dbg_status_5_val

Prototype

uint32_t intel_vvp_genlock_controller_get_clk_dbg_status_5_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The frequency value for reference clock 3

intel_vvp_genlock_controller_get_pfd_dbg_status_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_dbg_status_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The PID error

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref0_int_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref0_int_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integer part of the TxRx reference # 0 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref0_frc_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref0_frc_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The fractional part of the TxRx reference # 0 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref1_int_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref1_int_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integer part of the TxRx reference # 1 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref1_frc_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref1_frc_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The fractional part of the TxRx reference # 1 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref2_int_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref2_int_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integer part of the TxRx reference # 2 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref2_frc_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref2_frc_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The fractional part of the TxRx reference # 2 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref3_int_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref3_int_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integer part of the TxRx reference # 3 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref3_frc_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_ref3_frc_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The fractional part of the TxRx reference # 3 clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_vcxo_int_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_vcxo_int_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The integer part of the TxRx VCXO clock ratio

intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_vcxo_frc_val

Prototype

uint32_t intel_vvp_genlock_controller_get_pfd_tx_rx_ratio_vcxo_frc_val (intel_vvp_genlock_controller_instance* instance);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

Returns

The fractional part of the TxRx VCXO clock ratio

intel_vvp_genlock_controller_set_pfd_control_enable

Prototype

int intel_vvp_genlock_controller_set_pfd_control_enable (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_control_ref_clk_sw_sel

Prototype

int intel_vvp_genlock_controller_set_pfd_control_ref_clk_sw_sel (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_control_ref_clk_sw_rst

Prototype

int intel_vvp_genlock_controller_set_pfd_control_ref_clk_sw_rst (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_control_vcxo_clk_sw_rst

Prototype

int intel_vvp_genlock_controller_set_pfd_control_vcxo_clk_sw_rst (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_control_update_cnt_msbs

Prototype

int intel_vvp_genlock_controller_set_pfd_control_update_cnt_msbs (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_2_int_rst_val

Prototype

int intel_vvp_genlock_controller_set_lpf_control_2_int_rst_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_3_i_gain

Prototype

int intel_vvp_genlock_controller_set_lpf_control_3_i_gain (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_3_p_gain

Prototype

int intel_vvp_genlock_controller_set_lpf_control_3_p_gain (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_3_d_gain

Prototype

int intel_vvp_genlock_controller_set_lpf_control_3_d_gain (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_op_en

Prototype

int intel_vvp_genlock_controller_set_dac_control_op_en (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_data_sel

Prototype

int intel_vvp_genlock_controller_set_dac_control_data_sel (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_hold

Prototype

int intel_vvp_genlock_controller_set_dac_control_hold (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_op_force_low

Prototype

int intel_vvp_genlock_controller_set_dac_control_op_force_low (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_op_force_high

Prototype

int intel_vvp_genlock_controller_set_dac_control_op_force_high (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_clk_div_disable

Prototype

int intel_vvp_genlock_controller_set_dac_control_clk_div_disable (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_dac_control_ob_cpu_value

Prototype

int intel_vvp_genlock_controller_set_dac_control_ob_cpu_value (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_enable

Prototype

prototype: int intel_vvp_genlock_controller_set_lpf_control_1_enable (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_int_rst_dis

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_int_rst_dis (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_lock_loss_conf_en

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_lock_loss_conf_en (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

argument: instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_freq_lock_lsb

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_freq_lock_lsb (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_lock_status_mode

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_lock_status_mode (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_i_mode

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_i_mode (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_p_mode

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_p_mode (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_d_mode

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_d_mode (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_i_gain_sign_inv

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_i_gain_sign_inv (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_p_gain_sign_inv

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_p_gain_sign_inv (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_d_gain_sign_inv

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_d_gain_sign_inv (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_i_gain_frac

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_i_gain_frac (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_lpf_control_1_rst_dac_sat_latch

Prototype

int intel_vvp_genlock_controller_set_lpf_control_1_rst_dac_sat_latch (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref0_frc_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref0_frc_val (intel_vvp_genlock_controller_instance* instance, float in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref0_int_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref0_int_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref1_frc_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref1_frc_val (intel_vvp_genlock_controller_instance* instance, float in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref1_int_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref1_int_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref2_frc_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref2_frc_val (intel_vvp_genlock_controller_instance* instance, float in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref2_int_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref2_int_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref3_frc_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref3_frc_val (intel_vvp_genlock_controller_instance* instance, float in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref3_int_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_ref3_int_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_vcxo_frc_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_vcxo_frc_val (intel_vvp_genlock_controller_instance* instance, float in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr

intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_vcxo_int_val

Prototype

int intel_vvp_genlock_controller_set_pfd_tx_rx_ratio_vcxo_int_val (intel_vvp_genlock_controller_instance* instance, uint32_t in_val);

Arguments

instance, pointer to the intel_vvp_genlock_controller_instance

in_val, the input reference value

Returns

kIntelVvpGenlocControllerOk, otherwise kIntelVvpGenlockControllerInstanceErr