Video and Vision Processing Suite Intel® FPGA IP User Guide

ID 683329
Date 8/08/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

11.5. Clipper 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_clipper_regs.h

Include file: intel_vvp_clipper.h

Table 101.  Clipper API Reference
Name Description
intel_vvp_clipper_init Initialize the Clipper 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_clipper_get_lite_mode Returns if Lite mode is on
intel_vvp_clipper_get_debug_enabled Returns if Debug features is on
Intel_vvp_clipper_get_clipping_mode Returns the run-time clipping method
intel_vvp_clipper_is_running Returns if the IP is processing data
Intel_vvp_clipper_get_commit_status Returns if the IP has uncommitted writes
intel_vvp_clipper_get_status Reads the status register
intel_vvp_clipper_set_left_offset Writes new value to the left offset register
intel_vvp_clipper_set_top_offset Writes new value to the top offset register
intel_vvp_clipper_set_right_offset Writes new value to the right offset register
intel_vvp_clipper_set_bottom_offset Writes new value to the bottom offset register
intel_vvp_clipper_set_clip_offsets Writes new values to the four offset registers
intel_vvp_clipper_set_clip_width Writes new value to the clipping width register
intel_vvp_clipper_set_clip_height Writes new value to the clipping height register
intel_vvp_clipper_set_clip_area Writes new values to the offset/clip registers
intel_vvp_clipper_get_left_offset Reads the left offset register
intel_vvp_clipper_get_top_offset Reads the top offset register
intel_vvp_clipper_get_right_offset Reads the right offset register
intel_vvp_clipper_get_bottom_offset Reads the bottom offset register
intel_vvp_clipper_get_clip_offsets Reads the four offset registers
intel_vvp_clipper_get_clip_width Reads the clipping width register
intel_vvp_clipper_get_clip_height Reads the clipping height register
intel_vvp_clipper_get_clip_area Reads the offset and clip registers
intel_vvp_clipper_commit_writes Commit all outstanding writes

enum eIntelVvpClippingMode

Members

kIntelVvpOffsetClipping – Clipping with four offsets from the input borders

kIntelVvpRectangleClipping – Clipping with a top-left offset and the dimensions of the clipped area

kIntelVvpInvalidClipping – Invalid clipping (used to indicate errors)

Description
Enumeration for the supported clipping methods

intel_vvp_clipper_init

Prototype
int intel_vvp_clipper_init(intel_vvp_clipper_instance *instance, intel_vvp_core_base base);
Description

Initializes a clipper 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 does not fully initialized and should not be used further by the application if returning a non-zero error code.

Arguments

instance – pointer to the intel_vvp_clipper_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 TPG product ID

kIntelVvpCoreInstanceErr if the instance is a null pointer

kIntelVvpClipperRegMapVersionErr if the register map is not supported

intel_vvp_clipper_get_lite_mode

Description

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

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

true if the IP is parameterized in lite mode

intel_vvp_clipper_get_debug_enabled

Prototype
bool intel_vvp_clipper_get_debug_enabled(intel_vvp_clipper_instance *instance);
Description

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

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

true if the IP is parameterized with debug features enabled

intel_vvp_clipper_get_clipping_mode

Prototype
eIntelVvpClippingMode intel_vvp_clipper_get_clipping_mode(intel_vvp_clipper_instance *instance);
Description

Returns the value of the CLIPPING_MODE register. The instance must be a valid intel_vvp_clipper_instance fully initialized.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

the clipping mode or kIntelVvpInvalidClipping in case of error

intel_vvp_clipper_is_running

Prototype
bool intel_vvp_ clipper _is_running(intel_vvp_clipper_instance* instance);
Description

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

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

True is the IP is currently generating an output field, false when between two fields

intel_vvp_clipper_get_commit_status

Prototype
bool intel_vvp_clipper_get_commit_status(intel_vvp_clipper_instance* instance);
Description

Reads and returns the commit pending bit of the STATUS register. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured in full mode.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

True is the IP is configured in full mode and if the agent interface contains uncommitted writes.

intel_vvp_clipper_get_status

Prototype
uint8_t intel_vvp_clipper_get_status(intel_vvp_clipper_instance* instance);
Description

Reads and returns the STATUS register. The instance must be a valid intel_vvp_clipper_instance fully initialized.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

The value read from the status register

intel_vvp_clipper_set_left_offset

Prototype
int intel_vvp_clipper_set_left_offset(intel_vvp_clipper_instance* instance , uint16_t left_offset);
Description

Writes a new offset value to the LEFT_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

left_offset – new left offset value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_top_offset

Prototype
int intel_vvp_clipper_set_top_offset(intel_vvp_clipper_instance* instance , uint16_t top_offset);
Description

Writes a new offset value to the TOP_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

top_offset – new top offset value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_right_offset

Prototype
int intel_vvp_clipper_set_right_offset(intel_vvp_clipper_instance* instance , uint16_t right_offset);
Description

Writes a new offset value to the RIGHT_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with four offsets

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

right_offset – new right offset value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_bottom_offset

Prototype
int intel_vvp_clipper_set_bottom_offset(intel_vvp_clipper_instance* instance , uint16_t bottom_offset);
Description

Writes a new offset value to the BOTTOM_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with four offsets

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

bottom_offset – new bottom offset value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_clip_offsets

Prototype
int intel_vvp_clipper_set_clip_offsets(intel_vvp_clipper_instance* instance , uint16_t left_offset, uint16_t top_offset, uint16_t right_offset, uint16_t bottom_offset);
Description

Writes new offsets value to the four offset registers. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with four offsets

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

left_offset – new left offset value

top_offset – new top offset value

right_offset – new right offset value

bottom_offset – new bottom offset value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_clip_width

Prototype
int intel_vvp_clipper_set_clip_width(intel_vvp_clipper_instance *instance, uint32_t clip_width)
Description

Writes a new clipping width value to the CLIP_WIDTH register. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with two offsets and dimensions of the clipped area

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

clip_width – new clipped area width value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_clip_height

Prototype
int intel_vvp_clipper_set_clip_height(intel_vvp_clipper_instance *instance, uint32_t clip_height)
Description

Writes a new clipping height value to the CLIP_HEIGHT register. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with two offsets and dimensions of the clipped area

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

clip_height – new clipped area height value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_set_clip_area

Prototype
int intel_vvp_clipper_set_clip_area(intel_vvp_clipper_instance *instance, uint16_t left_offset , uint16_t top_offset , uint32_t clip_width, uint32_t clip_height)
Description

Writes new offsets and new dimensions to the offset and clipping registers. The instance must be a valid intel_vvp_clipper_instance fully initialized and configured for clipping with two offsets and dimensions of the clipped area

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

left_offset – new left offset value

top_offset – new top offset value

clip_width – new clipped area width value

clip_height – new clipped area height value

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

intel_vvp_clipper_get_left_offset

Prototype
uint16_t intel_vvp_clipper_get_left_offset(intel_vvp_clipper_instance* instance);
Description

Reads the LEFT_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

The left offset value

intel_vvp_clipper_get_top_offset

Prototype
uint16_t intel_vvp_clipper_get_top_offset(intel_vvp_clipper_instance* instance);
Description

Reads the TOP_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized and parameterized with debug features enabled

Arguments
instance – pointer to the intel_vvp_clipper_instance software driver instance structure
Returns

The top offset value

intel_vvp_clipper_get_right_offset

Prototype
uint16_t intel_vvp_clipper_get_right_offset(intel_vvp_clipper_instance* instance);
Description

Reads the RIGHT_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with four offsets, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

The right offset value

intel_vvp_clipper_get_bottom_offset

Prototype
uint16_t intel_vvp_clipper_get_bottom_offset(intel_vvp_clipper_instance* instance);
Description

Reads the BOTTOM_OFFSET register. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with four offsets, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

The bottom offset value

intel_vvp_clipper_get_clip_offsets

Prototype
int intel_vvp_clipper_get_clip_offsets(intel_vvp_clipper_instance* instance , uint16_t *left_offset, uint16_t *top_offset, uint16_t *right_offset, uint16_t *bottom_offset);
Description

Read current offsets value from the four offset registers. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with four offsets, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

left_offset – pointer to a uint16_t value to store the value read from the LEFT_OFFSET register

top_offset – pointer to a uint16_t value to store the value read from the TOP_OFFSET register

right_offset – pointer to a uint16_t value to store the value read from the RIGHT_OFFSET register

bottom_offset – pointer to a uint16_t value to store the value read from the BOTTOM_OFFSET register

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

kIntelVvpCoreNullPtrErr if one of the pointers to store an output value is the null pointer

intel_vvp_clipper_get_clip_width

Prototype
uint32_t intel_vvp_clipper_get_clip_width(intel_vvp_clipper_instance *instance)
Description

Reads the CLIP_WIDTH register. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with top-left offsets and dimensions of the clipped area, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

Current clipping with value

intel_vvp_clipper_get_clip_height

Prototype
uint32_t intel_vvp_clipper_get_clip_height(intel_vvp_clipper_instance *instance)
Description

Reads the CLIP_HEIGHT register. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with top-left offsets and dimensions of the clipped area, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

Current clipping height value

intel_vvp_clipper_get_clip_area

Prototype
int intel_vvp_clipper_get_clip_area(intel_vvp_clipper_instance *instance, uint16_t *left_offset , uint16_t *top_offset , uint32_t *clip_width, uint32_t *clip_height)
Description

Reads current top-left offset value from the two offset registers and dimensions of the clipped area from the clipping dimensions registers. The instance must be a valid intel_vvp_clipper_instance fully initialized, configured for clipping with top-left offsets and dimensions of the clipped area, and parameterized with debug features enabled

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

left_offset – pointer to a uint16_t value to store the value read from the LEFT_OFFSET register

top_offset – pointer to a uint16_t value to store the value read from the TOP_OFFSET register

right_offset – pointer to a uint32_t value to store the value read from the CLIP_WIDTH register

bottom_offset – pointer to a uint32_t value to store the value read from the CLIP_HEIGHT register

Returns

kIntelVvpCoreOk in case of success, negative value in case of errors

kIntelVvpCoreInstanceErr if the instance is invalid

kIntelVvpCoreNullPtrErr if one of the pointers to store an output value is the null pointer

intel_vvp_clipper_commit_writes

Prototype
int intel_vvp_clipper_commit_writes(intel_vvp_clipper_instance* instance)
Description

Commits all pending writes before processing the next field. The instance must be valid and parameterized in full mode.

Arguments

instance – pointer to the intel_vvp_clipper_instance software driver instance structure

Returns

kIntelVvpCoreOk (0) for success, negative error code otherwise