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

45.5. Video Frame Reader IP Software API

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

Register definition header file: intel_vvp_vfr_regs.h

Include file: intel_vvp_vfr.h

Table 868.  Frame Reader IP Software API
Name Description
intel_vvp_vfr_init Initialize the Frame Reader 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_vfr_get_lite_mode Returns if Lite mode is on
intel_vvp_vfr_get_debug_enabled Returns if Debug features is on
intel_vvp_vfr_get_max_height Returns the maximum supported height
intel_vvp_vfr_get_max_width Returns the maximum supported width
intel_vvp_vfr_get_max_buffer_sets Returns the maximum number of supported buffer sets
intel_vvp_vfr_get_bps Returns the number of bits per color sample
intel_vvp_vfr_get_number_of_color_planes Returns the number of color planes per pixel
intel_vvp_vfr_get_pixels_in_parallel Returns the number of pixels streamed in parallel
intel_vvp_vfr_get_mem_word_packing Returns the algorithm used for pixel packing in memory
intel_vvp_vfr_is_running Returns if the IP is currently processing video data
intel_vvp_vfr_get_commit_status Returns if there are uncommitted writes
intel_vvp_vfr_get_status Reads the status register
intel_vvp_vfr_get_last_buffer_read_addr Returns the memory address of the last buffer read
intel_vvp_vfr_set_num_buffer_sets Changes the number of buffer sets in use
intel_vvp_vfr_get_num_buffer_sets Returns the number of buffer sets in use
intel_vvp_vfr_set_buffer_mode Changes the use mode of buffer sets
intel_vvp_vfr_get_buffer_mode Returns the use mode of buffer sets
intel_vvp_vfr_set_starting_buffer_set Changes the initial buffer set
intel_vvp_vfr_get_starting_buffer_set Returns the initial buffer set
intel_vvp_vfr_set_run_mode Changes the run mode
intel_vvp_vfr_get_run_mode Returns the run mode
intel_vvp_vfr_set_fsync_mode Changes the field synchronization trigger
intel_vvp_vfr_get_fsync_mode Returns the field synchronization trigger
intel_vvp_vfr_set_bufset_num_buffers Sets the number of buffers in a set
intel_vvp_vfr_get_bufset_num_buffers Returns the number of buffers in a set
intel_vvp_vfr_set_bufset_inter_buffer_offset Sets the size of the buffers in a set
intel_vvp_vfr_get_bufset_inter_buffer_offset Returns the size of the buffers in a set
intel_vvp_vfr_set_bufset_inter_line_offset Sets the size allocated for a field line in a set
intel_vvp_vfr_get_bufset_inter_line_offset Returns the size allocated for a field line in a set
intel_vvp_vfr_set_bufset_height Sets the height of fields in a set
intel_vvp_vfr_get_bufset_height Returns the height of fields in a set
intel_vvp_vfr_set_bufset_width Sets the width of fields in a set
intel_vvp_vfr_get_bufset_width Returns the width of fields in a set
intel_vvp_vfr_set_bufset_interlace Sets the interlace nibble of the first field in a set
intel_vvp_vfr_get_bufset_interlace Returns the interlace nibble of the first field in a set
intel_vvp_vfr_set_bufset_colorspace Sets the colorspace of fields in a set
intel_vvp_vfr_get_bufset_colorspace Returns the colorspace of fields in a set
intel_vvp_vfr_set_bufset_subsampling Sets the subsampling of fields in a set
intel_vvp_vfr_get_bufset_subsampling Returns the subsampling of fields in a set
intel_vvp_vfr_set_bufset_cositing Sets the cositing of fields in a set
intel_vvp_vfr_get_bufset_cositing Returns the cositing of fields in a set
intel_vvp_vfr_set_bufset_bps Sets the bps value for fields in a set
intel_vvp_vfr_get_bufset_bps Returns the bps value for fields in a set
intel_vvp_vfr_set_bufset_field_count Sets the field count value for fields in a set
intel_vvp_vfr_get_bufset_field_count Returns the field count value for fields in a set
intel_vvp_vfr_commit_writes Commit all outstanding writes

enum eIntelVvpVfrPacking

Members

kIntelVvpVfrPerfectPacking (0) - Perfect sample packing (no bits wasted)

kIntelVvpVfrColorPacking (1) - Color sample packing (color samples are not split across memory words)

kIntelVvpVfrPixelPacking (2) - Pixel packing (pixels are not split across memory words)

kIntelVvpVfrInvalidPacking (-1) - Invalid packing algorithm (used to indicate errors)

Description

Enumeration for the configurable sample packing in memory algorithms

enum eIntelVvpVfrRunMode

Members

kIntelVvpVfrStop (0) - Frame Reader is stopped

kIntelVvpVfrFreeRunning (1) - Frame Reader proceeds in a round-robin scheme using all buffers made available

kIntelVvpVfrFsync (2) - Frame Reader proceeds as above but waits for fsync trigger to start reading a new buffer

kIntelVvpVfrSingleShot (3) - Frame Reader reads across the buffers once

kIntelVvpVfrInvalidRunMode (-1) – Invalid value (used to indicate errors)

Description

Enumeration for the various read methods

enum eIntelVvpVfrBufferMode

Members

kIntelVvpVfrSingleSet (0) - A single set of buffers is used

kIntelVvpVfrAllSets (1) - All sets configured are used

kIntelVvpVfrInvalidBufferMode (-1) – Invalid value (used to indicate errors)

Description

Enumeration for the usage of the sets of buffer

enum eIntelVvpVfrFsyncMode

Members

kIntelVvpVfrFsyncBoth (0) - Triggers on both edges of the sync signal

kIntelVvpVfrFsyncRising (1) - Triggers on the rising edge of the sync signal

kIntelVvpVfrInvalidFsyncMode (-1) – Invalid value (used to indicate errors)

Description

Enumeration for the two fsync trigger mechanisms

intel_vvp_vfr_init

Prototype
int intel_vvp_vfr_init(intel_vvp_vfr_instance *instance, intel_vvp_core_base base);
Description

Initializes a Frame Reader 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_vfr_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 Frame Reader product ID

kIntelVvpCoreInstanceErr if the instance is a null pointer

kIntelVvpFrame ReaderRegMapVersionErr if the register map is not supported

intel_vvp_vfr_get_lite_mode

Prototype
bool intel_vvp_vfr_get_lite_mode(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

true if the IP is parameterized in lite mode

intel_vvp_vfr_get_debug_enabled

Prototype
 bool intel_vvp_vfr_get_debug_enabled(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

true if the IP is parameterized with debug features enabled

intel_vvp_vfr_get_max_height

Prototype
 uint32_t intel_vvp_vfr_get_max_height(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

The maximum supported height set at configuration

intel_vvp_vfr_get_max_width

Prototype
 uint32_t intel_vvp_vfr_get_max_width(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

The maximum supported width set at configuration

intel_vvp_vfr_get_max_buffer_sets

Prototype
 eIntelVvpDilAlgorithms intel_vvp_vfr_get_max_buffer_sets(intel_vvp_vfr_instance *instance);
Description

Returns the value of the MAX_BUFFER_SETS register. The instance must be a valid intel_vvp_vfr_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

The maximum nuber of sets of buffers configurable

intel_vvp_vfr_get_bps

Prototype
 uint8_t intel_vvp_vfr_get_bps(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

the number of bits per color sample selected at configuration

intel_vvp_vfr_get_number_of_color_planes

Prototype
 uint8_t intel_vvp_vfr_get_number_of_color_planes(intel_vvp_vfr_instance *instance);
Description

Returns the value of the NUMBER_OF_COLOR_PLANES register. The instance must be a valid intel_vvp_vfr_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

the number of color planes per pixel selected at configuration

intel_vvp_vfr_get_pixels_in_parallel

Prototype
 uint8_t intel_vvp_vfr_get_pixels_in_parallel(intel_vvp_vfr_instance *instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

the number of pixels streamed in parallel selected at configuration

intel_vvp_vfr_get_mem_word_packing

Prototype
 eIntelVvpVfrPacking intel_vvp_vfr_get_mem_word_packing(intel_vvp_vfr_instance *instance);
Description

Returns the value of the WORD_PACKING register. The instance must be a valid intel_vvp_vfr_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

the algorithm used to pack/unpack pixels and color samples of a field in memory

intel_vvp_vfr_is_running

Prototype
 bool intel_vvp_vfr_is_running(intel_vvp_vfr_instance* instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

True is the IP is currently reading a field, false when between two output fields

intel_vvp_vfr_get_commit_status

Prototype
 bool intel_vvp_vfr_get_commit_status(intel_vvp_vfr_instance* instance);
Description

Reads and returns the commit status bit of the STATUS register. The instance must be a valid intel_vvp_vfr_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

True is there are uncommitted writes

intel_vvp_vfr_get_status

Prototype
 uint32_t intel_vvp_vfr_get_status(intel_vvp_vfr_instance* instance);
Description

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

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

The content of the STATUS register

intel_vvp_vfr_get_last_buffer_read_addr

Prototype
 uint32_t intel_vvp_vfr_get_last_buffer_read_addr(intel_vvp_vfr_instance* instance);
Description

Reads the LAST_BUFFER_READ register. The instance must be a valid intel_vvp_vfr_instance fully initialized.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

The memory address of the last buffer read

intel_vvp_vfr_set_num_buffer_sets

Prototype
 int intel_vvp_vfr_set_num_buffer_sets(intel_vvp_vfr_instance *instance, uint8_t num_sets);
Description

Writes a new value to the NUM_BUFFER_SETS register and changes the number of active buffer sets

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

num_sets - new number of buffer sets in the range [1..MAX_NUM_BUFFER_SETS]

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid or the new number of buffer sets is invalid/unsupported

intel_vvp_vfr_get_num_buffer_sets

Prototype
 uint8_t intel_vvp_vfr_get_num_buffer_sets(intel_vvp_vfr_instance* instance);
Description

Reads and returns the number of buffer sets in use. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

Last value written to the NUM_BUFFER_SETS register if the IP is configured to enable register read-back

intel_vvp_vfr_set_buffer_mode

Prototype
 int intel_vvp_vfr_set_buffer_mode(intel_vvp_vfr_instance *instance, eIntelVvpVfrBufferMode buffer_mode);
Description

Writes a new value to the BUFFER_MODE register and selects if the IP uses a single set or all configured sets

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

buffer_mode - either kIntelVvpVfrSingleSet or kIntelVvpVfrAllSets

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid or the buffer_mode argument is invalid

intel_vvp_vfr_get_buffer_mode

Prototype
 eIntelVvpVfrBufferMode intel_vvp_vfr_get_buffer_mode(intel_vvp_vfr_instance* instance);
Description

Reads and returns the current value of the BUFFER_MODE register. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

Last value written to the BUFFER_MODE register if the IP is configured to enable register read-back

intel_vvp_vfr_set_starting_buffer_set

Prototype
 int intel_vvp_vfr_set_starting_buffer_set(intel_vvp_vfr_instance *instance, uint8_t starting_buffer_set);
Description

Writes a new value to the STARTING_BUFFER_SET register and selects the first active buffer set when a read starts

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

starting_buffer_set - the new active set if buffer_mode is kIntelVvpVfrSingleSet or the starting buffer set if buffer_mode is kIntelVvpVfrAllSets, this should be in the range [0..num_buffer_sets - 1]

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_starting_buffer_set

Prototype
 uint8_t intel_vvp_vfr_get_starting_buffer_set(intel_vvp_vfr_instance* instance);
Description

Reads and returns the current value of the STARTING_BUFFER_SET register. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

Last value written to the STARTING_BUFFER_SET register if the IP is configured to enable register read-back

intel_vvp_vfr_set_run_mode

Prototype
 int intel_vvp_vfr_set_run_mode(intel_vvp_vfr_instance *instance, eIntelVvpVfrRunMode run_mode);
Description

Writes a new value to the RUN_MODE register and chooses the read selection process used while outputting buffers. Note that the chosen STARTING_BUFFER_SET and BUFFER_MODE also have an impact on the run-time read behavior. Writes to the RUN_MODE register take effect after commit.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

run_mode - the new run_mode

kIntelVvpVfrStop to stop the frame reader until another run-mode is selected

kIntelVvpVfrFreeRunning to process through the buffer sets and the buffers within the buffer sets in a round-robin fashion

kIntelVvpVfrFsync to process through the buffers in the same order as in free-running mode but using the fsync signal to trigger each buffer read

kIntelVvpVfrSingleShot to process through the buffers in the same order as in free-running mode but stopping once all buffers have been read and output once

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_run_mode

Prototype
 eIntelVvpVfrRunMode intel_vvp_vfr_get_run_mode(intel_vvp_vfr_instance* instance);
Description

Reads and returns the current value of the RUN_MODE register. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

Last value written to the RUN_MODE register if the IP is configured to enable register read-back

intel_vvp_vfr_set_fsync_mode

Prototype
 int intel_vvp_vfr_set_fsync_mode(intel_vvp_vfr_instance *instance, eIntelVvpVfrFsyncMode sync_mode);
Description

Writes a new value to the FSYNC_PULSE_MODE register and selects the first active buffer set when a read starts

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

sync_mode - the new fsync trigger mechanism, kIntelVvpVfrFsyncRising to trigger the next field read on a rising fsync edge, kIntelVvpVfrFsyncBoth to trigger on either edge

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_fsync_mode

Prototype
 eIntelVvpVfrFsyncMode intel_vvp_vfr_get_fsync_mode(intel_vvp_vfr_instance* instance);
Description

Reads and returns the current value of the FSYNC_PULSE_MODE register. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

Last value written to the FSYNC_PULSE_MODE register if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_base_addr

Prototype
 int intel_vvp_vfr_set_bufset_base_addr(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t base_addr);
Description

Writes a new value to the BUFSET_BASE_ADDR register of the chosen buffer set and selects a new base address for the first buffer of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

base_addr - the base address for the first buffer of the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_base_addr

Prototype
 uint32_t intel_vvp_vfr_get_bufset_base_addr(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_BASE_ADDR register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_BASE_ADDR register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_num_buffers

Prototype
 int intel_vvp_vfr_set_bufset_num_buffers(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t num_buffers);
Description

Writes a new value to the BUFSET_NUM_BUFFERS register of the chosen buffer set and selects a new number of buffers in the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

num_buffers - new number of buffers

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_num_buffers

Prototype
 uint32_t intel_vvp_vfr_get_bufset_num_buffers(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_NUM_BUFFERS register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_NUM_BUFFERS register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_inter_buffer_offset

Prototype
 int intel_vvp_vfr_set_bufset_inter_buffer_offset(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t inter_buffer_offset);
Description

Writes a new value to the BUFSET_INTER_BUFFER_OFFSET register of the chosen buffer set and selects a new inter-buffer offset for the buffers of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

inter_buffer_offset - the offset, in bytes, between two buffers in the set, or, in other words, the number of bytes allocated to each buffer in the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_inter_buffer_offset

Prototype
 uint32_t intel_vvp_vfr_get_bufset_inter_buffer_offset(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_INTER_BUFFER_OFFSET register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_INTER_BUFFER_OFFSET register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_inter_line_offset

Prototype
 int intel_vvp_vfr_set_bufset_inter_line_offset(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t inter_line_offset);
Description

Writes a new value to the INTER_LINE_OFFSET register of the chosen buffer set and selects a new inter-line offset for the buffers of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

inter_line_offset - the offset, in bytes, between consecutive lines

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_inter_line_offset

Prototype
 uint32_t intel_vvp_vfr_get_bufset_inter_line_offset(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the INTER_LINE_OFFSET register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the INTER_LINE_OFFSET register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_height

Prototype
 int intel_vvp_vfr_set_bufset_height(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t height);
Description

Writes a new value to the BUFSET_HEIGHT register of the chosen buffer set and selects a new field height for the buffers of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

height - the new field height for the buffers of the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_height

Prototype
 uint32_t intel_vvp_vfr_get_bufset_height(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_HEIGHT register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_HEIGHT register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_width

Prototype
 int intel_vvp_vfr_set_bufset_width(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t width);
Description

Writes a new value to the BUFSET_WIDTH register of the chosen buffer set and selects a new width for the buffers of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

width - the new width for the buffers of the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_width

Prototype
 uint32_t intel_vvp_vfr_get_bufset_width(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_WIDTH register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_WIDTH register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_interlace

Prototype
 int intel_vvp_vfr_set_bufset_interlace(intel_vvp_vfr_instance *instance, uint8_t bufset, uint32_t interlace);
Description

Writes a new value to the BUFSET_INTERLAC register of the chosen buffer set and selects a new interlace nubble for the first buffer of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

interlace - the interlace nibble for the first field in the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_interlace

Prototype
 uint32_t intel_vvp_vfr_get_bufset_interlace(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_INTERLAC register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_INTERLAC register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_colorspace

Prototype
 int intel_vvp_vfr_set_bufset_colorspace(intel_vvp_vfr_instance *instance, uint8_t bufset, uint8_t colorspace);
Description

Writes a new value to the BUFSET_COLORSPACE register of the chosen buffer set and selects a new colorspace for the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

colorspace - the new colorspace code for the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_colorspace

Prototype
 uint8_t intel_vvp_vfr_get_bufset_colorspace(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_COLORSPACE register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_COLORSPACE register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_subsampling

Prototype
 int intel_vvp_vfr_set_bufset_subsampling(intel_vvp_vfr_instance *instance, uint8_t bufset, uint8_t subsampling);
Description

Writes a new value to the BUFSET_SUBSAMPLING register of the chosen buffer set and selects a new subsampling for the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

subsampling - the new subsampling code for the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_subsampling

Prototype
 uint8_t intel_vvp_vfr_get_bufset_subsampling(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_SUBSAMPLING register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_SUBSAMPLING register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_cositing

Prototype
 int intel_vvp_vfr_set_bufset_cositing(intel_vvp_vfr_instance *instance, uint8_t bufset, uint8_t cositing);
Description

Writes a new value to the BUFSET_COSITING register of the chosen buffer set and selects a new cositing for the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

cositing - the new cositing code for the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_cositing

Prototype
 uint8_t intel_vvp_vfr_get_bufset_cositing(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_COSITING register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_COSITING register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_bps

Prototype
 int intel_vvp_vfr_set_bufset_bps(intel_vvp_vfr_instance *instance, uint8_t bufset, uint8_t bps);
Description

Writes a new value to the BUFSET_BPS register of the chosen buffer set and selects a new bits per sample value for the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

bps - the new bits per sample value for the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_bps

Prototype
 uint8_t intel_vvp_vfr_get_bufset_bps(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_BPS register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_BPS register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_set_bufset_field_count

Prototype
 int intel_vvp_vfr_set_bufset_field_count(intel_vvp_vfr_instance *instance, uint8_t bufset, uint16_t field_count);
Description

Writes a new value to the BUFSET_FIELD_COUNT register of the chosen buffer set and selects a new field_count value for the first buffer of the set

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

field_count - the new field_count value for the first buffer of the set

Returns

kIntelVvpCoreOk for success, negative error code in case of failures

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_vfr_get_bufset_field_count

Prototype
 uint16_t intel_vvp_vfr_get_bufset_field_count(intel_vvp_vfr_instance* instance, uint8_t bufset);
Description

Reads and returns the current value of the BUFSET_FIELD_COUNT register for the selected buffer set. The instance must be a valid intel_vvp_vfr_instance fully initialized and configured to enable debug.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

bufset - the buffer set ID in the range [0..MAX_BUFFER_SETS]

Returns

Last value written to the BUFSET_FIELD_COUNT register for the selected buffer set if the IP is configured to enable register read-back

intel_vvp_vfr_commit_writes

Prototype
 int intel_vvp_vfr_commit_writes(intel_vvp_vfr_instance* instance)
Description

Commits all pending writes before processing the next field. The instance must be valid.

Arguments

instance - pointer to the intel_vvp_vfr_instance software driver instance structure

Returns

kIntelVvpCoreOk (0) for success, negative error code otherwise