Video and Vision Processing Suite Intel® FPGA IP User Guide

ID 683329
Date 5/08/2024
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 Plane Manager Intel® FPGA IP 21. Color Space Converter Intel® FPGA IP 22. Defective Pixel Correction Intel® FPGA IP 23. Deinterlacer Intel® FPGA IP 24. Demosaic Intel® FPGA IP 25. FIR Filter Intel® FPGA IP 26. Frame Cleaner Intel® FPGA IP 27. Full-Raster to Clocked Video Converter Intel® FPGA IP 28. Full-Raster to Streaming Converter Intel® FPGA IP 29. Genlock Controller Intel® FPGA IP 30. Generic Crosspoint Intel® FPGA IP 31. Genlock Signal Router Intel® FPGA IP 32. Guard Bands Intel® FPGA IP 33. Histogram Statistics Intel® FPGA IP 34. Interlacer Intel® FPGA IP 35. Mixer Intel® FPGA IP 36. Pixels in Parallel Converter Intel® FPGA IP 37. Scaler Intel® FPGA IP 38. Stream Cleaner Intel® FPGA IP 39. Switch Intel® FPGA IP 40. Tone Mapping Operator Intel® FPGA IP 41. Test Pattern Generator Intel® FPGA IP 42. Unsharp Mask Intel® FPGA IP 43. Video and Vision Monitor Intel FPGA IP 44. Video Frame Buffer Intel® FPGA IP 45. Video Frame Reader Intel FPGA IP 46. Video Frame Writer Intel FPGA IP 47. Video Streaming FIFO Intel® FPGA IP 48. Video Timing Generator Intel® FPGA IP 49. Vignette Correction Intel® FPGA IP 50. Warp Intel® FPGA IP 51. White Balance Correction Intel® FPGA IP 52. White Balance Statistics Intel® FPGA IP 53. Design Security 54. Document Revision History for Video and Vision Processing Suite User Guide

17.6. Clocked Video Input 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 described in Video and Vision Processing IPs Software API are applicable.

intel_vvp_cvi_init

prototype:
int intel_vvp_cvi_init(intel_vvp_cvi_instance* instance, intel_vvp_core_base base);
description:

Initialization function for a VVP CVI instance.

Attempts to initialize the fields of the CVI and its base core

argument:

instance, pointer to the intel_vvp_ cvi _instance to initialize

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

return value:

kIntelVvpCoreOk success

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 cvi product id

kIntelVvpCoreInstanceErr if the instance parameter is zero (null pointer)

intel_vvp_cvi_get_param_vid_pid

prototype:
int intel_vvp_cvi_get_param_vid_pid(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The product ID number

intel_vvp_cvi_get_param_version_number

prototype:
int intel_vvp_cvi_get_param_version_number(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The IP version number

intel_vvp_cvi_get_param_pip

prototype:
int intel_vvp_cvi_get_param_pip(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The number of pixels in parallel

intel_vvp_cvi_get_param_color_planes

prototype:
int intel_vvp_cvi_get_param_color_planes(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The number of color planes

intel_vvp_cvi_get_param_bps

prototype:
int intel_vvp_cvi_get_param_bps(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The number of bits per sample

intel_vvp_cvi_get_param_tready_present

prototype:
int intel_vvp_cvi_get_param_tready_present(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the TREADY signal is present on the input interface, otherwise the conduit is not present

intel_vvp_cvi_get_param_line_buffer_depth

prototype:
int intel_vvp_cvi_get_param_line_buffer_depth(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The maximum depth of the output video line buffer

intel_vvp_cvi_get_param_extended_video_metrics_enabled

prototype:
int intel_vvp_cvi_get_param_extended_video_metrics_enabled(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the extended video metric logic was included during build-time

intel_vvp_cvi_get_param_clk_freq_out

prototype:
int intel_vvp_cvi_get_param_clk_freq_out(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The output video frequency in Hz

intel_vvp_cvi_enable_go

prototype:
int intel_vvp_cvi_enable_go(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_disable_go

prototype:
int intel_vvp_cvi_disable_go(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_go

prototype:
uint16_t intel_vvp_cvi_get_go(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the go bit

intel_vvp_cvi_enable_status_update_interrupt

prototype:
int intel_vvp_cvi_enable_status_update_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_disable_status_update_interrupt

prototype:
int intel_vvp_cvi_disable_status_update_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_disable_status_update_interrupt

prototype:
uint16_t intel_vvp_cvi_get_status_update_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the status_update_interrupt bit

intel_vvp_cvi_enable_end_of_field_frame_interrupt

prototype:
int intel_vvp_cvi_enable_end_of_field_frame_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_disable_end_of_field_frame_interrupt

prototype:
int intel_vvp_cvi_disable_end_of_field_frame_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_end_of_field_frame_interrupt

prototype:
uint16_t intel_vvp_cvi_get_end_of_field_frame_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the end_of_field_frame_interrupt bit

intel_vvp_cvi_enable_frame_cleaner

prototype:
int intel_vvp_cvi_enable_frame_cleaner(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_disable_frame_cleaner

prototype:
int intel_vvp_cvi_disable_frame_cleaner(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_frame_cleaner

prototype:
uint16_t intel_vvp_cvi_get_frame_cleaner(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the frame_cleaner bit

intel_vvp_cvi_enable_auto_polarity_detection

prototype:
int intel_vvp_cvi_enable_auto_polarity_detection(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_disable_auto_polarity_detection

prototype:
int intel_vvp_cvi_disable_auto_polarity_detection(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_auto_polarity_detection

prototype:
uint16_t intel_vvp_cvi_get_auto_polarity_detection(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the auto_polarity_detection bit

intel_vvp_cvi_set_manual_vsync_polarity_high

prototype:
int intel_vvp_cvi_set_manual_vsync_polarity_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_manual_vsync_polarity_low

prototype:
int intel_vvp_cvi_set_manual_vsync_polarity_low(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_manual_vsync_polarity

prototype:
uint16_t intel_vvp_cvi_get_manual_vsync_polarity(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the manual_vsync_polarity bit

intel_vvp_cvi_set_manual_hsync_polarity_high

prototype:
int intel_vvp_cvi_set_manual_hsync_polarity_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_manual_hsync_polarity_low

prototype:
int intel_vvp_cvi_set_manual_hsync_polarity_low(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_manual_hsync_polarity

prototype:
uint16_t intel_vvp_cvi_get_manual_hsync_polarity(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the manual_hsync_polarity bit

intel_vvp_cvi_is_producing_data

prototype:
bool intel_vvp_cvi_is_producing_data(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_interlaced

prototype:
bool intel_vvp_cvi_is_interlaced(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_blank_timing

prototype:
bool intel_vvp_cvi_is_blank_timing(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_overflowed

prototype:
bool intel_vvp_cvi_is_overflowed(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_internal_locked_high

prototype:
bool intel_vvp_cvi_is_internal_locked_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_external_locked_high

prototype:
bool intel_vvp_cvi_is_external_locked_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_picture_drop

prototype:
bool intel_vvp_cvi_is_picture_drop(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_vsync_high

prototype:
bool intel_vvp_cvi_is_vsync_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_is_hsync_high

prototype:
bool intel_vvp_cvi_is_hsync_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

intel_vvp_cvi_clear_status_update_interrupt

prototype:
int intel_vvp_cvi_clear_status_update_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_status_update_interrupt

prototype:
int intel_vvp_cvi_get_status_update_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the status_update_interrupt bit

intel_vvp_cvi_clear_end_of_field_interrupt

prototype:
int intel_vvp_cvi_clear_end_of_field_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_get_end_of_field_interrupt

prototype:
uint16_t intel_vvp_cvi_get_end_of_field_interrupt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the end_of_field_interrupt bit

intel_vvp_cvi_get_total_sample_count

prototype:
uint16_t intel_vvp_cvi_get_total_sample_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the total_sample_count register field

intel_vvp_cvi_get_active_sample_count

prototype:
uint16_t intel_vvp_cvi_get_active_sample_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the active_sample_count register field

intel_vvp_cvi_get_active_line_count_f0

prototype:
uint16_t intel_vvp_cvi_get_active_line_count_f0(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the active_line_count_f0 register field

intel_vvp_cvi_get_active_line_count_f1

prototype:
uint16_t intel_vvp_cvi_get_active_line_count_f1(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the active_line_count_f1 register field

intel_vvp_cvi_get_total_line_count_f0

prototype:
uint16_t intel_vvp_cvi_get_total_line_count_f0(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the total_line_count_f0 register field

intel_vvp_cvi_get_total_line_count_f1

prototype:
uint16_t intel_vvp_cvi_get_total_line_count_f1(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the total_line_count_f1 register field

intel_vvp_cvi_get_reference_height_count

prototype:
uint16_t intel_vvp_cvi_get_reference_height_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the reference_height_count register field

intel_vvp_cvi_get_reference_width_count

prototype:
uint16_t intel_vvp_cvi_get_reference_width_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the reference_width_count register field

intel_vvp_cvi_get_reference_frames_count

prototype:
uint16_t intel_vvp_cvi_get_reference_frames_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the reference_frame_count register field

intel_vvp_cvi_get_reference_lines_count

prototype:
uint16_t intel_vvp_cvi_get_reference_lines_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the reference_lines_count register field

intel_vvp_cvi_get_clk_in_freq_count

prototype:
uint16_t intel_vvp_cvi_get_clk_in_freq_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the clk_in_freq_count register field

intel_vvp_cvi_get_tpg_comp4

prototype:
uint16_t intel_vvp_cvi_get_tpg_comp4(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the tpg_comp4 register field

intel_vvp_cvi_get_tpg_comp3

prototype:
uint16_t intel_vvp_cvi_get_tpg_comp3(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the tpg_comp3 register field

intel_vvp_cvi_get_tpg_comp2

prototype:
uint16_t intel_vvp_cvi_get_tpg_comp2(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the tpg_comp2 register field

intel_vvp_cvi_get_tpg_comp1

prototype:
uint16_t intel_vvp_cvi_get_tpg_comp1(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the tpg_comp1 register field

intel_vvp_cvi_get_total_fr_pixels_per_frames_count

prototype:
uint16_t intel_vvp_cvi_get_total_fr_pixels_per_frames_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the total_fr_pixels_per_frames_count register field

intel_vvp_cvi_get_total_active_pixels_per_frames_count

prototype:
uint16_t intel_vvp_cvi_get_total_active_pixels_per_frames_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the total_active_pixels_per_frames_count register field

intel_vvp_cvi_get_fr_blanking_pixels_count

prototype:
uint16_t intel_vvp_cvi_get_fr_blanking_pixels_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the fr_blanking_pixels_count register field

intel_vvp_cvi_get_fr_blanking_lines_count

prototype:
uint16_t intel_vvp_cvi_get_fr_blanking_lines_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the fr_blanking_lines_count register field

intel_vvp_cvi_get_hpulse_count

prototype:
uint16_t intel_vvp_cvi_get_hpulse_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hpulse_count register field

intel_vvp_cvi_get_hfp_count

prototype:
uint16_t intel_vvp_cvi_get_hfp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hfp_count register field

intel_vvp_cvi_get_hbp_count

prototype:
uint16_t intel_vvp_cvi_get_hbp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hbp_count register field

intel_vvp_cvi_get_f0_vfp_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vfp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vfp_count register field

intel_vvp_cvi_get_f1_vfp_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vfp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vfp_count register field

intel_vvp_cvi_get_f0_vpulse_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vpulse_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vpulse_count register field

intel_vvp_cvi_get_f1_vpulse_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vpulse_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vpulse_count register field

intel_vvp_cvi_get_f0_vbp_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vbp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vbp_count register field

intel_vvp_cvi_get_f1_vbp_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vbp_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vbp_count register field

intel_vvp_cvi_get_hpulse_ref_count

prototype:
uint16_t intel_vvp_cvi_get_hpulse_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hpulse_count register field

intel_vvp_cvi_get_hfp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_hfp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hfp_ref_count register field

intel_vvp_cvi_get_hbp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_hbp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the hbp_ref_count register field

intel_vvp_cvi_get_f0_vfp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vfp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vfp_ref_count register field

intel_vvp_cvi_get_f1_vfp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vfp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vfp_ref_count register field

intel_vvp_cvi_get_f0_vpulse_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vpulse_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vpulse_ref_count register field

intel_vvp_cvi_get_f1_vpulse_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vpulse_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vpulse_ref_count register field

intel_vvp_cvi_get_f0_vbp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f0_vbp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f0_vbp_ref_count register field

intel_vvp_cvi_get_f1_vbp_ref_count

prototype:
uint16_t intel_vvp_cvi_get_f1_vbp_ref_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the f1_vbp_ref_count register field

intel_vvp_cvi_get_input_freq_mhz

prototype:
float intel_vvp_cvi_get_input_freq_mhz(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of the clock input frequency value

intel_vvp_cvi_get_fps

prototype:
float intel_vvp_cvi_get_fps(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

the current value of number of frames per seconds

intel_vvp_cvi_set_reference_height_count

prototype:
int intel_vvp_cvi_set_reference_height_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output height counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_reference_width_count

prototype:
int intel_vvp_cvi_set_reference_width_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output width counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_reference_frames_count

prototype:
int intel_vvp_cvi_set_reference_frames_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output frame counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_reference_lines_count

prototype:
int intel_vvp_cvi_set_reference_lines_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output line counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_tpg_comp4

prototype:
int intel_vvp_cvi_set_tpg_comp4(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the pixel value for color plane # 4

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_tpg_comp3

prototype:
int intel_vvp_cvi_set_tpg_comp3(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the pixel value for color plane # 3

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_tpg_comp2

prototype:
int intel_vvp_cvi_set_tpg_comp2(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the pixel value for color plane # 2

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_tpg_comp1

prototype:
int intel_vvp_cvi_set_tpg_comp1(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the pixel value for color plane # 1

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_hpulse_ref_count

prototype:
intel_vvp_cvi_set_hpulse_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output hpulse counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_hfp_ref_count

prototype:
intel_vvp_cvi_set_hfp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output hfp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_hbp_ref_count

prototype:
intel_vvp_cvi_set_hbp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output hbp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f0_vfp_ref_count

prototype:
intel_vvp_cvi_set_f0_vfp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f0_vfp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f1_vfp_ref_count

prototype:
intel_vvp_cvi_set_f1_vfp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f1_vfp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f0_vpulse_ref_count

prototype:
intel_vvp_cvi_set_f0_vpulse_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f0_vpulse counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f1_vpulse_ref_count

prototype:
intel_vvp_cvi_set_f1_vpulse_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f1_vpulse counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f0_vbp_ref_count

prototype:
intel_vvp_cvi_set_f0_vbp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f0_vbp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

intel_vvp_cvi_set_f1_vbp_ref_count

prototype:
intel_vvp_cvi_set_f1_vbp_ref_count(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f1_vbp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

int intel_vvp_cvi_set_field_ref_cnt

prototype:
 int intel_vvp_cvi_set_field_ref_cnt(intel_vvp_cvi_instance* instance, uint16_t in_val);
argument:

instance, pointer to the intel_vvp_cvi_instance

in_val, the reference value for the output f1_vbp counter

return value:

if success kIntelVvpCviOk, otherwise kIntelVvpCviInstanceErr

uint16_t intel_vvp_cvi_get_field_ref_cnt

prototype:
uint16_t intel_vvp_cvi_get_field_ref_cnt(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The current value of the field reference counter

bool intel_vvp_cvi_is_vid_in_clk_stopped

prototype:
bool intel_vvp_cvi_is_vid_in_clk_stopped(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

bool intel_vvp_cvi_is_fr_field_high

prototype:
bool intel_vvp_cvi_is_fr_field_high(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

1 if the bit is asserted, otherwise 0

uint16_t intel_vvp_cvi_get_active_total_line_count

prototype:
uint16_t intel_vvp_cvi_get_active_total_line_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The current value of the number of active lines per frame

uint16_t intel_vvp_cvi_get_f1_fps_count

prototype:
uint16_t intel_vvp_cvi_get_f1_fps_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The current value of the frames per second for field 0

uint16_t intel_vvp_cvi_get_f1_fps_count

prototype:
uint16_t intel_vvp_cvi_get_f1_fps_count(intel_vvp_cvi_instance* instance);
argument:

instance, pointer to the intel_vvp_cvi_instance

return value:

The current value of the frames per second for field 0