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

26.4. Guard Bands IP Registers

Each register is either read-only (RO) or read-write (RW).
Table 429.  Guard Bands IP RegistersIn the software API the register names appear with a prefix of INTEL_VVP, INTEL_VVP_CORE or INTEL_VVP_GUARD_BANDS as appropriate and with an optional REG suffix
Address Register Access Description
Lite70 Full
Parameterization registers
0x0000 VID_PID RO RO

Read this register to retrieve the Guard Bands Intel FPGA IP product ID.

This register always returns 0x6AF7_0231.

0x0004 VERSION RO RO

Read this register to retrieve the version information for the Configurable Guard Bands IP.

0x0008 LITE_MODE RO RO

Read this register to determine if Lite mode is on or off.

This register returns 0 when you turn off Lite mode and 1 for when you turn on Lite mode.

0x000C DEBUG_ENABLED RO RO

Read this register to determine if Debug features is on or off.

0x0010 NUM_GB_VALUES RO RO Read this register to determine the number of guard bands that you can set. Equivalent to number of color planes or (number of color planes + 1) if you turn on 4:2:2 support.
0x0014 to 0x011F - - - Unused.

Control and debug registers

For more information, refer to Control Packets

0x0120 IMG_INFO_WIDTH RW RO When you turn on Lite, the expected width of the incoming video fields. When you turn off Lite, the received width in image information packets.
0x0124 IMG_INFO_HEIGHT RW RO When you turn on Lite, the expected height of the incoming video fields. When you turn off Lite, the received height in image information packets.
0x0128 IMG_INFO_INTERLACE RW RO When you turn on Lite, the expected interlace information of the incoming video fields. When you turn off Lite, the received interlace information in image information packets.
0x012C Reserved RW RO Unused.
0x0130 IMG_INFO_COLORSPACE RW RO When you turn on Lite, the expected color space of the incoming video fields. When you turn off Lite, the received color space in image information packets.
0x0134 IMG_INFO_SUBSAMPLING RW RO When you turn on Lite, the expected chroma sub-sampling of the incoming video fields. When you turn off Lite, the received chroma sub-sampling in image information packets.
0x0138 IMG_INFO_COSITING RW RO When you turn on Lite, the expected chroma co-siting of the incoming video fields. When you turn off Lite, the received chroma co-siting in image information packets.
0x013C IMG_INFO_FIELD_COUNT RO RO The received field count field in image information packets.
0x0140 STATUS RO RO

Bit 0: Status bit.

1 means the IP is processing a video field, 0 otherwise.

When you turn off Lite:

Bit 1: Pending register updates bit.

Any writes to the specification registers (0x0148 - 0x0154) cause the IP to raise the pending register updates bit, to indicate outstanding changes to the guard band settings.

The IP lowers this bit at the start of the first packet for a new frame (first packet after the EOP) after a write to the COMMIT register.

0x0144 COMMIT RW RW

The IP uses this register with the STATUS register Pending register updates bit.

Write any value to this register after writing new values to any of the specification registers (0x0148 - 0x0154). The configurable guard bands change to the new guard band specification values at the start of the next video frame after the IP writes to this register.

The COMMIT register ensures atomic register updates, avoiding the IP only applying some of the updated register values for the next incoming frame.

Specification registers
0x0148 GB_0_VALUES RW RW

Write to this register to set the lower and upper guard band values for color plane 0.

0x014C GB_1_VALUES RW RW

Write to this register to set the lower and upper guard band values for color plane 1. Unused if NUM_GB_VALUES < 2.

0x0150 GB_2_VALUES RW RW

Write to this register to set the lower and upper guard band values for color plane 2.

Unused if NUM_GB_VALUES < 3.

0x0154 GB_3_VALUES RW RW

Write to this register to set the lower and upper guard band values for color plane 3.

Unused if NUM_GB_VALUES < 4.

Register Bit Descriptions

Table 430.  VID_PID
Name Bits Description
Guard Bands Intel FPGA IP vendor ID and product ID 31:0 This register always returns 0x6AF7_0231.
  • 15:0 is the product ID and always returns 0x0231
  • 31:16 is the vendor ID and always returns 0x6AF7
Table 431.  VERSION
Name Bits Description
Register map version 7:0 Register map version. Returns 0x01.
QPDS patch revision 15:8 Returns 0x00
QPDS update revision 23:16 Updated for each release. For 21.4, returns 0x04
QPDS major revision 31:24 Updated for each release. For 21.4, returns 0x15.
Table 432.  LITE_MODE
Name Bits Description
Lite mode parameterization bit 0 Returns 1 if you turn on lite mode.
Unused 31:1 Unused.
Table 433.  DEBUG_ENABLED
Name Bits Description
Debug features parameterization bit 0 Returns 1 if you turn on debug features.
Unused 31:1 Unused.
Table 434.  NUM_GB_VALUES
Name Bits Description
Number of GB values used 3:0 This field indicates number of guard bands that are active. Equivalent to number of color planes or (number of color planes + 1) if you turn on 4:2:2 support.
Unused 31:4 Unused.
Table 435.  IMG_INFO_WIDTH
Name Bits Description
Width bits 15:0

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

When you turn off Lite and turn on Debug features, this register returns the width field from the most recently received.

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

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

When you turn off Lite and turn on Debug features, this register returns the height field from the most recently received.

Unused 31:16 Unused.
Table 437.  IMG_INFO_INTERLACE
Name Bits Description
interlaced bits 3:0

When you turn on Lite, write to this register to set the expected interlacing of the incoming video fields.

When you turn off Lite and turn on Debug features, this register returns the intlaceNibble field from the most recently received image information packet .

Unused 31:4 Unused.
Table 438.  IMG_INFO_COLORSPACE
Name Bits Description
Color space code bits 6:0

When you turn on Lite, write to this register to set the expected color space of the incoming video fields.

When you turn off Lite and turn on Debug features, this register returns the CSP field from the most recently received image information packet .

Unused 31:7 Unused.
Table 439.  IMG_INFO_SUBSAMPLING
Name Bits Description
Subsampling code bits 1:0

When you turn on Lite, write to this register to set the expected chroma sub-sampling of the incoming video fields.

When you turn off Lite and turn on Debug features, this register returns the SUBSA field from the most recently received image information packet.

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

When you turn on Lite, write to this register to set the expected chroma co-siting of the incoming video fields.

When you turn off Lite and turn on Debug features, this register returns the COSITE field from the most recently received image information packet.

Unused 31:2 Unused.
Table 441.  STATUS
Name Bits Description
Status bit 0 1 means configurable guard bands are processing a video field, 0 otherwise.
Pending register updates bit 1 1 means configurable guard bands have pending updates, 0 otherwise.
Table 442.  COMMIT
Name Bits Description
Commit bits 31:0 Write to any bits to trigger a commit.
Table 443.  GB_0_VALUES
Name Bits Description
GB_0_LOWER_VALUE 15:0 Write to this register to set the lower guard band value for color plane 0.
GB_0_UPPER_VALUE 31:16 Write to this register to set the upper guard band value for color plane 0.
Table 444.  GB_1_VALUES
Name Bits Description
GB_1_LOWER_VALUE 15:0 Write to this register to set the lower guard band value for color plane 1. Unused if NUM_GB_VALUES < 2.
GB_1_UPPER_VALUE 31:16 Write to this register to set the upper guard band value for color plane 1. Unused if NUM_GB_VALUES < 2.
Table 445.   GB_2_VALUES
Name Bits Description
GB_2_LOWER_VALUE 15:0 Write to this register to set the lower guard band value for color plane 2. Unused if NUM_GB_VALUES < 3.
GB_2_UPPER_VALUE 31:16 Write to this register to set the upper guard band value for color plane 2. Unused if NUM_GB_VALUES < 3.
Table 446.  GB_3_VALUES
Name Bits Description
GB_3_LOWER_VALUE 15:0 Write to this register to set the lower guard band value for color plane 3. Unused if NUM_GB_VALUES < 4.
GB_3_UPPER_VALUE 31:16 Write to this register to set the upper guard band value for color plane 3. Unused if NUM_GB_VALUES < 4.
70

When you turn on lite mode, registers are RW only if you turn on Debug features, otherwise they are WO. For full, turn off lite mode.