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

26.5. Frame Cleaner IP Registers

Each register is either read-only (RO) or read-write (RW).
Table 433.  Frame Cleaner IP Control Registers

In the software API these register names appear with a prefix of INTEL_VVP, INTEL_VVP_CORE or INTEL_VVP_CLEANER as appropriate and with an optional REG suffix

Address Register Access Description
Parameterization Registers
0x0000 PROD_ID RO

Read this register to retrieve the frame cleaner product ID.

This register always returns 0x6AF7_023E.

0x0004 VERSION RO

Read this register to retrieve the IP version information.

0x0008 LITE_MODE RO

Read this register to determine if lite mode is on.

This register returns 1 if lite mode is on and 0 if lite mode is off

0x000C DEBUG_ENABLED RO

Read this register to determine if you turn on Debug features.

This register returns 1 if you turn on Debug features and 0 otherwise

0x0010 USE_CUSTOM_MIN_MAX RO

Read this register to determine if the custom resolution guard bands are on.

This register returns 1 if custom resolution guard bands are on, and 0 otherwise

0x0014 MIN_WIDTH RO Read this register to determine the minimum supported field width
0x0018 MAX_WIDTH RO Read this register to determine the maximum supported field width
0x001C MIN_HEIGHT RO Read this register to determine the minimum supported field height
0x0020 MAX_HEIGHT RO Read this register to determine the maximum supported field height
0x0024 to 0x011F unused
Table 434.  Control and debugging registers

Refer to Image Information Control Packets in the Intel FPGA Streaming Video Protocol Specification, for more details of these registers

Address Register Access 72 Description
Lite Full
0x0120 IMG_INFO_WIDTH RW RO

When you turn on lite, use this register to set the expected width of incoming video fields.

When you turn off lite and turn on Debug features, this register returns the width that the frame cleaner derives from information in the image information control packet.

0x0124 IMG_INFO_HEIGHT RW RO

When you turn on lite, use this register to set the expected height of incoming video fields.

When you turn off lite and turn on Debug features, this register returns the height that the frame cleaner derives from information in the image information control packet.

0x0128 IMG_INFO_INTERLACE - RO When you turn off lite and turn on Debug features, this register returns the interlace nibble that the frame cleaner derives from information in the image information control packet. Unused in lite mode.
0x012C Reserved - - Reserved
0x0130 IMG_INFO_COLORSPACE - RO When you turn off lite and turn on Debug features, this register returns the color space that the frame cleaner derives from information in the image information control packet. Unused in lite mode.
0x0134 IMG_INFO_SUBSAMPLING - RO When you turn off lite and turn on Debug features, this register returns the subsampling that the frame cleaner derives from information in the image information control packet. Unused in lite mode.
0x0138 IMG_INFO_COSITING - RO When you turn off lite and turn on Debug features, this register returns the cositing that the frame cleaner derives from information in the image information control packet. Unused in lite mode.
0x013C IMG_INFO_FIELD_COUNT - RO When you turn off lite and turn on Debug features, this register returns the field count that the frame cleaner derives from information in the image information control packet. Unused in lite mode.
0x0138 to 0x013C unused
0x0140 STATUS RO  

Bit 0 : Status bit.

1 = frame cleaner is processing a video field, 0 otherwise. For other bits, see Table 21

0x0144

FIELD_NUM

RO   When you turn off lite and turn on Debug features, reads to this register return the field number value from the most recently received end of field control packet.
0x0148 FIELD_COUNT RO   When you turn on Debug features, reads to this register return the total number of fields received since the debug counts were last reset.
0x014C CLIPPED_FIELD_COUNT RO   When you turn on Debug features, reads to this register return the number of fields that have been clipped to match their expected size since the debug counts were last reset.
0x0150 PADDED_FIELD_COUNT RO   When you turn on Debug features, reads to this register return the number of fields that have been padded to match their expected size since the debug counts were last reset.
0x0154 PREV_FIELD_LINE_COUNT RO   When you turn on Debug features, reads to this register return the number of lines in the most recently completed field.
0x0158 PREV_FIELD_LINE_WIDTH RO   When you turn on Debug features, reads to this register return the number of pixels in the final line of the most recently completed field.
0x015C DEBUG_RESET RW   Write any value to this register to reset all debug counts to 0.

Register Bit Descriptions

Table 435.  PROD_ID
Name Bits Description
Frame cleaner product ID 31:0 This register always returns 0x6AF7_023E.
Table 436.  VERSION
Name Bits Description
Register map version 7:0 Register map version.
IP patch revision 15:8 -
IP update revision 23:16 Updated when the IP version changes.
IP major revision 31:24 Updated when the IP version changes.
Table 437.  LITE_MODE
Name Bits Description
Lite mode parameterization bit 31:0 Returns 1 if lite mode is on and 0 otherwise
Table 438.  DEBUG_ENABLED
Name Bits Description
Debug features parameterization bit 31:0 Returns 1 if debug features is on and 0 otherwise
Table 439.  USE_CUSTOM_MIN_MAX
Name Bits Description
Use custom min max 31:0 Returns 1 if custom minimum and maximum resolution checks are enabled
Table 440.  MIN_WIDTH
Name Bits Description
Min width 31:0 Minimum output field width
Table 441.  MAX_WIDTH
Name Bits Description
Max width 31:0 Maximum output field width
Table 442.  MIN_HEIGHT
Name Bits Description
Min height 31:0 Minimum output field height

Table 443.  MAX_HEIGHT
Name Bits Description
Max height 31:0 Maximum output field height
Table 444.   IMG_INFO_WIDTH
Name Bits Description
Width bits 15:0

For lite parameterizations, write to this register to set the expected width of the incoming video fields.

For full parameterizations with debug features enabled, this register returns the width-1 field from the most recently received image information packet and adds 1 to return a value for width.

unused 31:16 Unused.
Table 445.  IMG_INFO_HEIGHT
Name Bits Description
Height bits 15:0

For lite parameterizations, write to this register to set the expected height of the incoming video fields.

For full parameterizations with debug features enabled, this register reads the height-1 field from the most recently received image information packet and adds 1 to return a value for height.

unused 31:16 Unused.
Table 446.  IMG_INFO_INTERLACE
Name Bits Description
IntlaceNibble bits 3:0

For lite parameterizations, this register has no function.

For full parameterizations with debug features enabled, this register returns the intlaceNibble field from the most recently received image information packet .

unused 31:4 Unused.
Table 447.   IMG_INFO_COLORSPACE
Name Bits Description
CSP code bits 6:0

For lite parameterizations, this register has no function.

For full parameterizations with debug features enabled, this register returns the 7 bit CSP field from the most recently received image information packet .

unused 31:7 Unused.
Table 448.  IMG_INFO_SUBSAMPLING
Name Bits Description
SubSa code bits 1:0

For lite parameterizations this register has no function.

For full parameterizations with debug features enabled, this register returns the SUBSA field from the most recently received image information packet.

unused 31:2 Unused.
Table 449.  IMG_INFO_COSITING
Name Bits Description
Cosite code bits 1:0

For lite parameterizations, this register has no function.

For full parameterizations with debug features enabled, this register returns the COSITE field from the most recently received image information packet.

unused 31:2 Unused.
Table 450.  IMG_INFO_FIELD_COUNT
Name Bits Description
Count bits 6:0

For lite parameterizations, this register has no function.

For full parameterizations with debug features enabled, this register returns the 7 bit FIELD_COUNT field from the most recently received image information packet.

unused 31:7 Unused.
Table 451.  STATUS
Name Bits Description
Status bit 0 1 = frame cleaner is processing a video field, 0 otherwise.
Field clipping bit 1 1 = current field is being clipped, 0 otherwise
Field padding bit 2 1 = current field is being padded, 0 otherwise
Previous field clipped 3 1 = previous field was clipped, 0 otherwise
Previous field padded 4 2 = previous field was padded, 0 otherwise
unused 31:5 Unused.
Table 452.  FIELD_NUM
Name Bits Description
Field num 31:0 Field number value taken from the most recently received eof control packet
Table 453.  FIELD_COUNT
Name Bits Description
Field count 31:0 Number of fields received since last debug reset
Table 454.   CLIPPED_FIELD_COUNT
Name Bits Description
Clipped field count 31:0 Number of fields clipped since last debug reset
Table 455.  PADDED_FIELD_COUNT
Name Bits Description
Padded field count 31:0 Number of fields padded since last debug reset
Table 456.   PREV_FIELD_LINE_COUNT
Name Bits Description
Previous field line count 31:0 Number of lines in last completed field
Table 457.  PREV_FIELD_LINE_WIDTH
Name Bits Description
Previous field line width 31:0 Number of pixels in the final line of the previous field
Table 458.  DEBUG_RESET
Name Bits Description
unused 31:0 Unused.
72

You must turn on Debug features to read the values stored in these registers. If Debug features is off, reads to these registers return undefined data. The only exception is the STATUS register, the value of which you can always read.