Video and Vision Processing Suite Intel® FPGA IP User Guide

ID 683329
Date 10/02/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. 3D LUT Intel® FPGA IP 9. AXI-Stream Broadcaster Intel® FPGA IP 10. Bits per Color Sample Adapter Intel FPGA IP 11. Chroma Key Intel® FPGA IP 12. Chroma Resampler Intel® FPGA IP 13. Clipper Intel® FPGA IP 14. Clocked Video Input Intel® FPGA IP 15. Clocked Video to Full-Raster Converter Intel® FPGA IP 16. Clocked Video Output Intel® FPGA IP 17. Color Space Converter Intel® FPGA IP 18. Deinterlacer Intel® FPGA IP 19. FIR Filter Intel® FPGA IP 20. Frame Cleaner Intel® FPGA IP 21. Full-Raster to Clocked Video Converter Intel® FPGA IP 22. Full-Raster to Streaming Converter Intel® FPGA IP 23. Genlock Controller Intel® FPGA IP 24. Generic Crosspoint Intel® FPGA IP 25. Genlock Signal Router Intel® FPGA IP 26. Guard Bands Intel® FPGA IP 27. Interlacer Intel® FPGA IP 28. Mixer Intel® FPGA IP 29. Pixels in Parallel Converter Intel® FPGA IP 30. Scaler Intel® FPGA IP 31. Stream Cleaner Intel® FPGA IP 32. Switch Intel® FPGA IP 33. Tone Mapping Operator Intel® FPGA IP 34. Test Pattern Generator Intel® FPGA IP 35. Video and Vision Monitor Intel FPGA IP 36. Video Frame Buffer Intel® FPGA IP 37. Video Frame Reader Intel FPGA IP 38. Video Frame Writer Intel FPGA IP 39. Video Streaming FIFO Intel® FPGA IP 40. Video Timing Generator Intel® FPGA IP 41. Warp Intel® FPGA IP 42. Design Security 43. Document Revision History for Video and Vision Processing Suite User Guide
Give Feedback

35.5. Video and Vision Monitor Software API

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

Register definition header file: intel_vvp_snoop_regs.h

Include file: intel_vvp_snoop.h

Table 662.  Video and Vision Monitor IP Software API
Name Description
intel_vvp_snoop_init Initialize the Video and Vision Monitor instance
intel_vvp_core_* Accessors defined in Video and Vision Processing IPs Software Programming Model . Writable when Lite is on. Readable when Lite is off and Debug features is on.
intel_vvp_snoop_get_lite_mode Returns if Lite mode is on
intel_vvp_snoop_get_debug_enabled Returns if Debug features is on
intel_vvp_snoop_get_pixels_in_parallel Returns the number of pixels streamed in parallel
intel_vvp_snoop_is_running Returns if the IP is currently processing video data
intel_vvp_snoop_get_status Reads the status register
intel_vvp_snoop_get_num_good_fields Returns the numbers of valid fields processed
intel_vvp_snoop_get_num_broken_fields Returns the numbers of broken fields processed (full variant)
intel_vvp_snoop_get_num_mismatch_fields EReturns the numbers of invalid/mismatched fields processed
intel_vvp_snoop_get_last_num_lines Returns the number of lines in the last processed field
intel_vvp_snoop_get_last_min_width Returns the width of the smallest line in the last processed field
intel_vvp_snoop_get_last_max_width Returns the width of the largest line in the last processed field
intel_vvp_snoop_reset_counters Resets all debug counters

intel_vvp_snoop_init

Prototype
int intel_vvp_snoop_init(intel_vvp_snoop_instance *instance, intel_vvp_core_base base);
Description

Initializes a Video and Vision Monitor instance. The initialization stops early if the vendor ID or product ID read at the base address are not a match or if the register map version is not supported. Otherwise, the function proceeds to read and store the IP compile-time parameterization. The instance is not fully initialized and the application should not use it further if returning a non-zero error code.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

base - base address of the register map

Returns

kIntelVvpCoreOk (0) in case of success, a negative error code in case of error

kIntelVvpCoreVidErr if the vendor id of the core is not the IntelFPGA vendor ID (0x6AF7).

kIntelVvpCorePidErr if the product_id does not match with the Video and Vision Monitor product ID

kIntelVvpCoreInstanceErr if the instance is a null pointer

kIntelVvpSnoopRegMapVersionErr if the register map is not supported

intel_vvp_snoop_get_lite_mode

Prototype
bool intel_vvp_snoop_get_lite_mode(intel_vvp_snoop_instance *instance);
Description

Returns the value of the LITE_MODE register. The instance must be a valid intel_vvp_snoop_instance fully initialized

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

true if the IP is parameterized in lite mode

intel_vvp_snoop_get_debug_enabled

Prototype
 bool intel_vvp_snoop_get_debug_enabled(intel_vvp_snoop_instance *instance);
Description

Returns the value of the DEBUG_ENABLED register. The instance must be a valid intel_vvp_snoop_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

true if the IP is parameterized with debug features enabled

intel_vvp_snoop_get_pixels_in_parallel

Prototype
 uint8_t intel_vvp_snoop_get_pixels_in_parallel(intel_vvp_snoop_instance *instance);
Description

Returns the value of the PIXELS_IN_PARALLEL register. The instance must be a valid intel_vvp_snoop_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the number of pixels streamed in parallel in the monitored Video and Vision stream interface

intel_vvp_snoop_is_running

Prototype
 bool intel_vvp_snoop_is_running(intel_vvp_snoop_instance* instance);
Description

Reads and returns the running bit of the STATUS register. The instance must be a valid intel_vvp_snoop_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

True is the IP is currently receiving/storing an input field, false when between two input fields

intel_vvp_snoop_get_status

Prototype
 uint32_t intel_vvp_snoop_get_status(intel_vvp_snoop_instance* instance);
Description

Reads the STATUS register. The instance must be a valid intel_vvp_snoop_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

The content of the STATUS register

intel_vvp_snoop_get_num_good_fields

Prototype
 uint16_t intel_vvp_snoop_get_num_good_fields(intel_vvp_snoop_instance* instance);
Description

Reads the NUM_GOOD_FIELDS register. The instance must be a valid intel_vvp_snoop_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the number of valid fields processed so far

intel_vvp_snoop_get_num_broken_fields

Prototype
 uint16_t intel_vvp_snoop_get_num_broken_fields(intel_vvp_snoop_instance *instance);
Description

Reads the NUM_BROKEN_FIELDS register. The instance must be a valid intel_vvp_snoop_instance fully initialized and configured in lite variant.

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the number of broken fields processed so far (counted using the broken flag in EOF packets in full variant)

intel_vvp_snoop_get_num_mismatch_fields

Prototype
 uint16_t intel_vvp_snoop_get_num_mismatch_fields(intel_vvp_snoop_instance* instance);
Description

Reads the NUM_MISMATCH_FIELDS register. The instance must be a valid intel_vvp_snoop_instance fully initialized

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the number of invalid fields processed so far, counted by looking for discrepencies between the image information and the number of pixels/lines received

intel_vvp_snoop_get_last_num_lines

Prototype
 uint32_t intel_vvp_snoop_get_last_num_lines(intel_vvp_snoop_instance *instance)
Description

Reads the LAST_NUM_LINES register. The instance must be a valid intel_vvp_snoop_instance fully initialized

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the number of lines in the last processed field

intel_vvp_snoop_get_last_min_width

Prototype
uint32_t intel_vvp_snoop_get_last_min_width(intel_vvp_snoop_instance *instance)
Description

Reads the LAST_MIN_WIDTH register. The instance must be a valid intel_vvp_snoop_instance fully initialized

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the width of the smallest line in the last processed field

intel_vvp_snoop_get_last_max_width

Prototype
 uint32_t intel_vvp_snoop_get_last_max_width(intel_vvp_snoop_instance *instance)
Description

Reads the LAST_MAX_WIDTH register. The instance must be a valid intel_vvp_snoop_instance fully initialized

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

the width of the largest line in the last processed field

intel_vvp_snoop_reset_counters

Prototype
 int intel_vvp_snoop_reset_counters(intel_vvp_snoop_instance *instance)
Description

Resets all debug counters to zero

Arguments

instance - pointer to the intel_vvp_snoop_instance software driver instance structure

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid