Video and Vision Processing Suite Intel® FPGA IP User Guide

ID 683329
Date 7/08/2024
Public
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. Adaptive Noise Reduction Intel® FPGA IP 11. Advanced Test Pattern Generator Intel® FPGA IP 12. AXI-Stream Broadcaster Intel® FPGA IP 13. Bits per Color Sample Adapter Intel FPGA IP 14. Black Level Correction Intel® FPGA IP 15. Black Level Statistics Intel® FPGA IP 16. Chroma Key Intel® FPGA IP 17. Chroma Resampler Intel® FPGA IP 18. Clipper Intel® FPGA IP 19. Clocked Video Input Intel® FPGA IP 20. Clocked Video to Full-Raster Converter Intel® FPGA IP 21. Clocked Video Output Intel® FPGA IP 22. Color Plane Manager Intel® FPGA IP 23. Color Space Converter Intel® FPGA IP 24. Defective Pixel Correction Intel® FPGA IP 25. Deinterlacer Intel® FPGA IP 26. Demosaic Intel® FPGA IP 27. FIR Filter Intel® FPGA IP 28. Frame Cleaner Intel® FPGA IP 29. Full-Raster to Clocked Video Converter Intel® FPGA IP 30. Full-Raster to Streaming Converter Intel® FPGA IP 31. Genlock Controller Intel® FPGA IP 32. Generic Crosspoint Intel® FPGA IP 33. Genlock Signal Router Intel® FPGA IP 34. Guard Bands Intel® FPGA IP 35. Histogram Statistics Intel® FPGA IP 36. Interlacer Intel® FPGA IP 37. Mixer Intel® FPGA IP 38. Pixels in Parallel Converter Intel® FPGA IP 39. Scaler Intel® FPGA IP 40. Stream Cleaner Intel® FPGA IP 41. Switch Intel® FPGA IP 42. Tone Mapping Operator Intel® FPGA IP 43. Test Pattern Generator Intel® FPGA IP 44. Unsharp Mask Intel® FPGA IP 45. Video and Vision Monitor Intel FPGA IP 46. Video Frame Buffer Intel® FPGA IP 47. Video Frame Reader Intel FPGA IP 48. Video Frame Writer Intel FPGA IP 49. Video Streaming FIFO Intel® FPGA IP 50. Video Timing Generator Intel® FPGA IP 51. Vignette Correction Intel® FPGA IP 52. Warp Intel® FPGA IP 53. White Balance Correction Intel® FPGA IP 54. White Balance Statistics Intel® FPGA IP 55. Design Security 56. Document Revision History for Video and Vision Processing Suite User Guide

44.5. Unsharp Mask IP 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_usm_regs.h

Include file: intel_vvp_usm.h

Table 829.   Unsharp Mask IP Software API
Name Description
intel_vvp_usm_init Initialize an IP instance
intel_vvp_core_* Accessors defined in Video and Vision Processing IPs Software Programming Model
intel_vvp_usm_get_lite_mode Returns if Lite mode is on
intel_vvp_usm_get_debug_enabled Returns if Debug features is on
intel_vvp_usm_get_bits_per_sample Returns the number of bits per color sample
intel_vvp_usm_get_pixels_in_parallel Returns the pixels in parallel of the streaming input and output interfaces
intel_vvp_usm_get_max_width Returns the maximum number of pixels that the IP supports on the horizontal dimension of an image or video frame
intel_vvp_usm_get_max_height Returns the maximum number of pixels that the IP supports on the vertical dimension of an image or video frame
intel_vvp_usm_is_running Reads if the IP is running
intel_vvp_usm_get_status Reads the status register
intel_vvp_usm_get_sharpening_strength Reads the sharpening strength
intel_vvp_usm_set_sharpening_strength Writes the sharpening strength
intel_vvp_usm_set_output_height Writes the output height
intel_vvp_usm_set_output_width Reads the output width

intel_vvp_usm_init

Prototype
                    int intel_vvp_usm_init(intel_vvp_usm_instance* instance, intel_vvp_core_base base);
                
Description

Initialize an IP 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_usm_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 an error

kIntelVvpCoreInstanceErr if the instance is a null pointer

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 expected product ID (0x0246)

kIntelVvpUsmRegMapVersionErr if the register map is not supported

intel_vvp_usm_get_lite_mode

Prototype
                    bool intel_vvp_usm_get_lite_mode(intel_vvp_usm_instance* instance);
                
Description

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

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

true if the IP is parameterized in lite mode

intel_vvp_usm_get_debug_enabled

Prototype
                    bool intel_vvp_usm_get_debug_enabled(intel_vvp_usm_instance* instance);
                
Description

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

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

true if the IP is parameterized with debug features enabled

intel_vvp_usm_get_bits_per_sample

Prototype
                    uint8_t intel_vvp_usm_get_bits_per_sample(intel_vvp_usm_instance* instance);
                
Description

Returns the value of the BPS register. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the bits per color sample parameter used to generate the IP

intel_vvp_usm_get_pixels_in_parallel

Prototype
                    uint8_t intel_vvp_usm_get_pixels_in_parallel(intel_vvp_usm_instance* instance);
                
Description

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

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the pixels in parallel parameter used to generate the IP

intel_vvp_usm_get_max_width

Prototype
                    uint32_t intel_vvp_usm_get_max_width(intel_vvp_usm_instance* instance);
                
Description

Returns the value of the MAX_WIDTH register. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the maximum field width parameter used to generate the IP

intel_vvp_usm_get_max_height

Prototype
                    uint32_t intel_vvp_usm_get_max_height(intel_vvp_usm_instance* instance);
                
Description

Returns the value of the MAX_HEIGHT register. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the maximum field height parameter used to generate the IP

intel_vvp_usm_is_running

Prototype
                    bool intel_vvp_usm_is_running(intel_vvp_usm_instance* instance);
                
Description

Returns the value of the IP Running bit from the STATUS register. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the running bit from the status register

intel_vvp_usm_get_status

Prototype
                    uint32_t intel_vvp_usm_get_status(intel_vvp_usm_instance* instance);
                
Description

Returns the value of the STATUS register. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the value of the status register

intel_vvp_usm_get_sharpening_strength

Prototype
                    uint32_t intel_vvp_usm_get_sharpening_strength(intel_vvp_usm_instance *instance);
                
Description

Returns the sharpening strength. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

Returns

the sharpening strength

intel_vvp_usm_set_sharpening_strength

Prototype
                    int intel_vvp_usm_set_sharpening_strength(intel_vvp_usm_instance* instance, uint16_t strength);
                
Description

Writes the sharpening strength. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

strength - new sharpening strength

Returns

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

kIntelVvpCoreInstanceErr if the instance is a null pointer

intel_vvp_usm_set_output_height

Prototype
                    bool intel_vvp_usm_set_output_height(intel_vvp_usm_instance* instance, uint32_t new_height);
                
Description

Writes the height of the field. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

new_height - new height of the field

Returns

true in case of success, false otherwise

intel_vvp_usm_set_output_width

Prototype
                    bool intel_vvp_usm_set_output_width(intel_vvp_usm_instance* instance, uint32_t new_width)
                
Description

Writes the width of the field. The instance must be a valid intel_vvp_usm_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_usm_instance software driver instance structure

new_width - new width of the field

Returns

true in case of success, false otherwise