Dataflow configuration

Deprecated APIs to configure DataFlows which have been requested from a CmdProgram.

Functions

cupvaError_t CupvaConfigDataFlowSetParams(cupvaDataFlow_t const df, cupvaConfigDataFlowParams_t *const cdfParams)

Set the parameters for a ConfigDataFlow.

cupvaError_t CupvaDataFlowGetId(cupvaDataFlow_t const df, int32_t *const id)

Get DataFlow's id.

cupvaError_t CupvaDynamicDataFlowSetParams(cupvaDataFlow_t const df, cupvaDynamicDataFlowParams_t *const ddfParams)

Set the parameters for a DynamicDataFlow.

cupvaError_t CupvaSetNodeParams(cupvaDataFlow_t const df, int32_t const nodeId, int32_t const laneId, cupvaNodeParams_t *const nodeParams)

Set the parameters for a DynamicDataFlow Node at laneId,nodeId.

cupvaError_t CupvaStaticDataFlowSetParams(cupvaDataFlow_t const df, cupvaStaticDataFlowParams_t *const sdfParams)

Set the parameters for a StaticDataFlow.

Data Structures

cupvaConfigDataFlowParams_t

Parameters structure for CupvaConfigDataFlowSetParams.

cupvaDynamicDataFlowParams_t

Parameters structure for CupvaDynamicDataFlowSetParams.

cupvaNodeParams_t

Parameters structure for CupvaSetNodeParams.

cupvaStaticDataFlowParams_t

Parameters structure for CupvaStaticDataFlowSetParams.

Functions

cupvaError_t CupvaConfigDataFlowSetParams(

cupvaDataFlow_t const df,

cupvaConfigDataFlowParams_t *const cdfParams,

)

Set the parameters for a ConfigDataFlow.

Deprecated:

This function is deprecated. Use GatherScatterDataFlow or SequenceDataFlow instead.

Usage considerations

• Allowed context for the API call

  • Thread-safe: No

• API group

  • Init: Yes

  • Runtime: No

  • De-Init: No

Parameters:

• df – [in] The pointer to a DataFlow object.

• cdfParams – [in] The pointer to cupvaConfigDataFlowParams_t struct.

Returns:

cupvaError_t The completion status of the operation. Possible values are:

• CUPVA_ERROR_NONE if the operation was successful.

• CUPVA_INVALID_ARGUMENT indicates one of the followings:

  • df was a null pointer.

  • cdfParams was a null pointer.

  • cdfParams->handler was not from VMEM.

  • cdfParams->vpuConfigTable was an invalid pointer, i.e. not pointing to the VMEM.

• CUPVA_INVALID_STATE if the object was not instantiated correctly.

cupvaError_t CupvaDataFlowGetId(

cupvaDataFlow_t const df,

int32_t *const id,

)

Get DataFlow’s id.

Deprecated:

This function is deprecated.

The id is only valid after the DataFlow is compiled. Only valid for ConfigDataFlow or StaticDataFlow types.

Usage considerations

• Allowed context for the API call

  • Thread-safe: Yes

• API group

  • Init: Yes

  • Runtime: No

  • De-Init: No

Parameters:

• df – [in] The pointer to the DataFlow object.

• id – [out] The pointer to the id value.

Returns:

cupvaError_t The completion status of the operation. Possible values are:

• CUPVA_ERROR_NONE if the operation was successful.

• CUPVA_INVALID_ARGUMENT if df was a null pointer.

• CUPVA_INVALID_ARGUMENT if df is not a ConfigDataFlow or a StaticDataFlow.

• CUPVA_INVALID_STATE if can’t get a valid id before it is compiled.

• CUPVA_INVALID_STATE if the object was not instantiated correctly.

cupvaError_t CupvaDynamicDataFlowSetParams(

cupvaDataFlow_t const df,

cupvaDynamicDataFlowParams_t *const ddfParams,

)

Set the parameters for a DynamicDataFlow.

Deprecated:

This function is deprecated. Use GatherScatterDataFlow or SequenceDataFlow instead.

With laneCount = 1, device side DDF scalar APIs: for instance, cupvaDDFOpen(), cupvaDDFClose(), cupvaDDFSync() and cupvaDDFTrig() should be used to avoid mismatches between host and VPU code.

Usage considerations

• Allowed context for the API call

  • Thread-safe: No

• API group

  • Init: Yes

  • Runtime: No

  • De-Init: No

Parameters:

• df – [in] The pointer to a DataFlow object.

• ddfParams – [in] The pointer to cupvaDynamicDataFlowParams_t struct.

Returns:

cupvaError_t The completion status of the operation. Possible values are:

• CUPVA_ERROR_NONE if the operation was successful.

• CUPVA_INVALID_ARGUMENT indicates one of the followings:

  • df was a null pointer.

  • ddfParams was a null pointer.

  • ddfParams->nodeCount was out-of-range.

  • ddfParams->laneCount was out-of-range.

• CUPVA_INVALID_STATE if the object was not instantiated correctly.

cupvaError_t CupvaSetNodeParams(

cupvaDataFlow_t const df,

int32_t const nodeId,

int32_t const laneId,

cupvaNodeParams_t *const nodeParams,

)

Set the parameters for a DynamicDataFlow Node at laneId,nodeId.

Deprecated:

This function is deprecated. Use GatherScatterDataFlow or SequenceDataFlow instead.

Usage considerations

• Allowed context for the API call

  • Thread-safe: No

• API group

  • Init: Yes

  • Runtime: No

  • De-Init: No

Parameters:

• df – [in] The pointer to a DataFlow object.

• nodeId – [in] The index of the node in the lane.

• laneId – [in] The index of the lane.

• nodeParams – [in] The pointer to cupvaNodeParams_t struct.

Returns:

cupvaError_t The completion status of the operation. Possible values are:

• CUPVA_ERROR_NONE if the operation was successful.

• CUPVA_INVALID_ARGUMENT indicates one of the followings:

  • df was a null pointer.

  • nodeParams was a null pointer.

  • nodeParams->padDir was invalid.

  • nodeParams->padDim was out-of-range.

  • nodeParams->padMode was invalid.

  • nodeParams->bpp value was not supported.

  • nodeParams->opSrc was an invalid pointer.

  • nodeParams->linePitchSrc was out-of-range.

  • nodeParams->opDst was an invalid pointer.

  • nodeParams->linePitchDst was out-of-range.

  • The tile size was out-of-range.

  • The node index was out-of-range.

  • The lane index was out-of-range.

• CUPVA_INVALID_STATE if the object was not instantiated correctly.

cupvaError_t CupvaStaticDataFlowSetParams(

cupvaDataFlow_t const df,

cupvaStaticDataFlowParams_t *const sdfParams,

)

Set the parameters for a StaticDataFlow.

Deprecated:

This function is deprecated. Use RasterDataFlow or SequenceDataFlow instead.

Usage considerations

• Allowed context for the API call

  • Thread-safe: No

• API group

  • Init: Yes

  • Runtime: No

  • De-Init: No

Parameters:

• df – [in] The pointer to a DataFlow object.

• sdfParams – [in] The pointer to cupvaStaticDataFlowParams_t struct.

Returns:

cupvaError_t The completion status of the operation. Possible values are:

• CUPVA_ERROR_NONE if the operation was successful.

• CUPVA_INVALID_ARGUMENT indicates one of the followings:

  • df was a null pointer.

  • sdfParams was a null pointer.

  • sdfParams->padDir was invalid or self-conflict.

  • sdfParams->padDim was out-of-range.

  • sdfParams->padMode was invalid.

  • sdfParams->GranularityType was invalid.

  • sdfParams->bpp was out-of-range.

  • sdfParams->niterSrcDim1 was out-of-range.

  • sdfParams->advSrcDim1 was out-of-range.

  • sdfParams->niterSrcDim2 was out-of-range.

  • sdfParams->advSrcDim2 was out-of-range.

  • sdfParams->niterSrcDim3 was out-of-range.

  • sdfParams->advSrcDim3 was out-of-range.

  • sdfParams->cbStartSrc was out-of-range.

  • sdfParams->cbLenSrc was out-of-range.

  • sdfParams->niterDstDim1 was out-of-range.

  • sdfParams->advDstDim1 was out-of-range.

  • sdfParams->niterDstDim2 was out-of-range.

  • sdfParams->advDstDim2 was out-of-range.

  • sdfParams->niterDstDim3 was out-of-range.

  • sdfParams->advDstDim3 was out-of-range.

  • sdfParams->cbStartDst was out-of-range.

  • sdfParams->cbLenDst was out-of-range.

  • sdfParams->linePitchSrc was out-of-range.

  • sdfParams->linePitchDst was out-of-range.

  • sdfParams->handler was not from VMEM.

  • The tile size was invalid.

  • sdfParams->ptrSrc and sdfParams->sdfParams->opSrc were invalid.

  • sdfParams->ptrDst and sdfParams->sdfParams->opDst were invalid.

• CUPVA_INVALID_STATE if the object was not instantiated correctly.