DSPLIB_subConstant

Introduction

Kernel for subtracting a input constant by an input data vector.

• The kernel support computation of vector of a batch of several inputs in one kernel call.

Data Structures
struct	DSPLIB_subConstant_InitArgs
	Structure containing the parameters to initialize the kernel. More...

Functions
int32_t	DSPLIB_subConstant_getHandleSize (DSPLIB_subConstant_InitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...
DSPLIB_STATUS	DSPLIB_subConstant_init (DSPLIB_kernelHandle handle, DSPLIB_bufParams1D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_subConstant_InitArgs *pKerInitArgs)
	This function should be called before the DSPLIB_subConstant_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the MMA accelerator and the streaming engine. The results of these operations are stored in the handle. More...
DSPLIB_STATUS	DSPLIB_subConstant_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_subConstant_InitArgs *pKerInitArgs)
	This function checks the validity of the parameters passed to DSPLIB_subConstant_init function. This function is called with the same parameters as the DSPLIB_subConstant_init, and this function must be called before the DSPLIB_subConstant_init is called. More...
DSPLIB_STATUS	DSPLIB_subConstant_exec_checkParams (DSPLIB_kernelHandle handle, const void *restrict pIn1, const void *restrict pIn2, const void *restrict pOut)
	This function checks the validity of the parameters passed to DSPLIB_subConstant_exec function. This function is called with the same parameters as the DSPLIB_subConstant_init, and this function must be called before the DSPLIB_subConstant_init is called. More...
DSPLIB_STATUS	DSPLIB_subConstant_exec (DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
	This function is the main kernel compute function. More...

Function Documentation

DSPLIB_subConstant_getHandleSize()

int32_t DSPLIB_subConstant_getHandleSize

(

DSPLIB_subConstant_InitArgs *

pKerInitArgs

)

This is a query function to calculate the size of internal handle.

Parameters

[in]

pKerInitArgs

: Pointer to structure holding init parameters

Returns

Size of the buffer in bytes

Remarks

Application is expected to allocate buffer of the requested size and provide it as input to other functions requiring it.

Definition at line 25 of file DSPLIB_subConstant.cpp.

DSPLIB_subConstant_init()

DSPLIB_STATUS DSPLIB_subConstant_init	(	DSPLIB_kernelHandle	handle,
		DSPLIB_bufParams1D_t *	bufParamsIn,
		DSPLIB_bufParams1D_t *	bufParamsOut,
		const DSPLIB_subConstant_InitArgs *	pKerInitArgs
	)

This function should be called before the DSPLIB_subConstant_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the MMA accelerator and the streaming engine. The results of these operations are stored in the handle.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[out]	bufParamsOut	: Pointer to the structure containing dimensional information of ouput buffer
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

Application is expected to provide a valid handle.

Definition at line 83 of file DSPLIB_subConstant.cpp.

DSPLIB_subConstant_init_checkParams()

DSPLIB_STATUS DSPLIB_subConstant_init_checkParams	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams1D_t *	bufParamsIn,
		const DSPLIB_bufParams1D_t *	bufParamsOut,
		const DSPLIB_subConstant_InitArgs *	pKerInitArgs
	)

This function checks the validity of the parameters passed to DSPLIB_subConstant_init function. This function is called with the same parameters as the DSPLIB_subConstant_init, and this function must be called before the DSPLIB_subConstant_init is called.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[out]	bufParamsOut	: Pointer to the structure containing dimensional information of output buffer
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

None

Definition at line 31 of file DSPLIB_subConstant.cpp.

DSPLIB_subConstant_exec_checkParams()

DSPLIB_STATUS DSPLIB_subConstant_exec_checkParams	(	DSPLIB_kernelHandle	handle,
		const void *restrict	pIn1,
		const void *restrict	pIn2,
		const void *restrict	pOut
	)

This function checks the validity of the parameters passed to DSPLIB_subConstant_exec function. This function is called with the same parameters as the DSPLIB_subConstant_init, and this function must be called before the DSPLIB_subConstant_init is called.

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn1	: Pointer to the structure input buffer 1
[in]	pIn2	: Pointer to the structure input buffer 2
[out]	pout	: Pointer to the output buffer

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

None

Definition at line 63 of file DSPLIB_subConstant.cpp.

DSPLIB_subConstant_exec()

DSPLIB_STATUS DSPLIB_subConstant_exec	(	DSPLIB_kernelHandle	handle,
		void *restrict	pIn1,
		void *restrict	pIn2,
		void *restrict	pOut
	)

This function is the main kernel compute function.

Please refer to details under DSPLIB_subConstant_exec

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn	: Pointer to buffer holding the input data
[out]	pOut	: Pointer to buffer holding the output data

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Assumptions:

• None

Performance Considerations:

For best performance,

• the input and output data buffers are expected to be in L2 memory
• the buffer pointers are assumed to be 64-byte aligned

Remarks

Before calling this function, application is expected to call DSPLIB_subConstant_init and DSPLIB_subConstant_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 180 of file DSPLIB_subConstant.cpp.