Video and Vision Processing Suite Intel® FPGA IP User Guide

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

18.5. FIR Filter Registers

Each register is either read-only (RO) or read-write (RW).
Address Register Access Description
Lite 45 Full
Parameterization registers
0x0000 PROD_ID RO

Read this register to retrieve the FIR Filter product ID.

This register always returns 0x6FA7_022C.

0x0004 VER RO

Read this register to retrieve the version information for the Intel Quartus release that Intel uses to build the FIR Filter.

0x0008 LITE_MODE RO

Read this register to determine if lite mode is on.

This register returns 0 for full mode and 1 for lite mode.

0x000C DEBUG_ENABLED RO

Read this register to determine if Debug features is on.

This register returns 0 for off and 1 for on.

0x0010 MAX_FRAME_WIDTH RO Read this register to determine the maximum supported input field width.
0x0014 MAX_FRAME_HEIGHT RO Read this register to determine the maximum supported input field height.
0x0018 BPS_IN RO Read this register to determine the bits per symbol for the input data.
0x001C BPS_OUT RO Read this register to determine the bits per symbol for the output data.
0x0020 ROUNDING_METHOD RO

Read this register to determine how the IPremoves the fractional bits when converting output result back to integer format.

  • 1: Round half up
  • 2: Round half even
  • 3: Truncate to integer
0x0024 BINARY_POINT_SHIFT RO Read this register to determine the number of places by which the binary point moves to the right. Use to scale the result of the calculation
0x0028 USE_FIXED_COEFF RO Read this register to determine if the IP is set to use a fixed coefficient file. This register returns 0 for false and 1 for true.
0x002C H_TAPS RO Read this register to determine the number of horizontal filter taps.
0x0030 V_TAPS RO Read this register to determine the number of vertical filter taps.
0x0034 HORIZONTAL_SYM_COEFFS RO Read this register to determine if horizontal kernel mirroring is on. This register returns 0 for false and 1 for true.
0x0038 VERTICAL_SYM_COEFFS RO Read this register to determine if vertical kernel mirroring is on. This register returns 0 for false and 1 for true.
0x003C DIAGONAL_SYM_COEFFS RO Read this register to determine if diagonal kernel mirroring is on. This register returns 0 for false and 1 for true
0x0040 SIGNED_COEFFS RO Read this register to determine whether the filter uses signed coefficients. This register returns 0 for unsigned and 1 for signed
0x0044 COEFF_INT_BITS RO Read this register to determine the number of integer bits that the fixed-point data type uses to store coefficients
0x0048 COEFF_FRAC_BITS RO Read this register to determine the number of fractional bits that the fixed-point data type uses to store coefficients
0x004C 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 mode, use this register to set the expected width of incoming video fields.

When you turn off Lite mode and turn on Debug features, this register returns the width that the FIR Filter derives from information in the image information packet

0x0124 IMG_INFO_HEIGHT RW RO

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

When you turn off Lite mode and turn on Debug features, this register returns the height that the FIR Filter derives from information in the image information packet.

0x0128 IMG_INFO_INTERLACE - RO

When you turn off Lite mode and turn on Debug features, this register returns the interlace nibble that the FIR Filter derives from information in the image information packet. Unused in lite mode

0x012C RESERVED - - Unused.
0x0130 IMG_INFO_COLORSPACE - RO When you turn off Lite mode and turn on Debug features, this register returns the color space that the FIR Filter derives from information in the image information packet. Unused in lite mode.
0x0134 IMG_INFO_SUBSAMPLING - RO

When you turn off Lite mode and turn on Debug features, this register returns the subsampling that the FIR Filter derives from information in the image information packet. Unused in lite mode.

0x0138 IMG_INFO_COSITING - RO

When you turn off Lite mode and turn on Debug features, this register returns the cositing that the FIR Filter derives from information in the image information packet. Unused in lite mode.

0x013C IMG_INFO_FIELD_COUNT - RO

When you turn off Lite mode and turn on Debug features, this register returns the field count that the FIR Filter derives from information in the image information packet. Unused in lite mode.

0x0140 STATUS RO RO
  • Bit 0: Status bit.. 1 means FIR Filter is processing a video field, 0 otherwise.
  • Bit 2: Algo core Idle. 1 indicates algorithmic core is finished processing all lines and it is safe to update coefficient values.
0x0144 to 0x0200 - - - Unused

0x0200 to 0x0200 + 4*(Number of coefficients-1)

COEFFICIENTS WO WO Up to [V_TAPS * H_TAPS] number of registers that set the new coefficient values. The coefficients apply to the filter kernel in raster scan order.
45

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.