DSPLIB_fir

Introduction

Kernel for convolving input data with an input filter.

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

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

Functions
int32_t	DSPLIB_fir_getHandleSize (DSPLIB_fir_InitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...
DSPLIB_STATUS	DSPLIB_fir_getSizes (const DSPLIB_fir_InitArgs *pKerInitArgs, DSPLIB_bufParams2D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsFilter, DSPLIB_bufParams2D_t *bufParamsOut)
	This is a query function to calculate the sizes of input, filter and the output buffers. More...
DSPLIB_STATUS	DSPLIB_fir_init (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsFilter, DSPLIB_bufParams2D_t *bufParamsOut, DSPLIB_fir_InitArgs *pKerInitArgs)
	This function should be called before the DSPLIB_fir_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_fir_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsFilter, const DSPLIB_bufParams2D_t *bufParamsOut, const DSPLIB_fir_InitArgs *pKerInitArgs)
	This function checks the validity of the parameters passed to DSPLIB_fir_init function. This function is called with the same parameters as the DSPLIB_fir_init, and this function must be called before the DSPLIB_fir_init is called. More...
DSPLIB_STATUS	DSPLIB_fir_exec (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pFilter, void *restrict pOut)
	This function is the main kernel compute function. More...
DSPLIB_STATUS	DSPLIB_fir_exec_checkParams (DSPLIB_kernelHandle handle, const void *restrict pIn, const void *restrict pFilter, const void *restrict pOut)
	This function checks the validity of the parameters passed to DSPLIB_fir_exec function. This function is called with the same parameters as the DSPLIB_fir_exec, and this function must be called before the DSPLIB_fir_exec is called. More...
void	DSPLIB_fir_perfEst (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsFilter, const DSPLIB_bufParams2D_t *bufParamsOut, uint64_t *archCycles, uint64_t *estCycles)
	This is a utility function that gives an estimate of the cycles consumed for the kernel execution. More...

Function Documentation

DSPLIB_fir_getHandleSize()

int32_t DSPLIB_fir_getHandleSize

(

DSPLIB_fir_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.

DSPLIB_fir_getSizes()

DSPLIB_STATUS DSPLIB_fir_getSizes	(	const DSPLIB_fir_InitArgs *	pKerInitArgs,
		DSPLIB_bufParams2D_t *	bufParamsIn,
		DSPLIB_bufParams1D_t *	bufParamsFilter,
		DSPLIB_bufParams2D_t *	bufParamsOut
	)

This is a query function to calculate the sizes of input, filter and the output buffers.

Parameters

[in]	pKerInitArgs	: Pointer to the structure holding init parameters
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of filter buffer
[in]	bufParamsOut	: Pointer to the structure containing dimensional information of ouput buffer

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

Application is expected to allocate buffers of the requested size, fill in the input data and filter data before making the DSPLIB_fir_exec function call.

DSPLIB_fir_init()

DSPLIB_STATUS DSPLIB_fir_init	(	DSPLIB_kernelHandle	handle,
		DSPLIB_bufParams2D_t *	bufParamsIn,
		DSPLIB_bufParams1D_t *	bufParamsFilter,
		DSPLIB_bufParams2D_t *	bufParamsOut,
		DSPLIB_fir_InitArgs *	pKerInitArgs
	)

This function should be called before the DSPLIB_fir_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
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of filter 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.

DSPLIB_fir_init_checkParams()

DSPLIB_STATUS DSPLIB_fir_init_checkParams	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsIn,
		const DSPLIB_bufParams1D_t *	bufParamsFilter,
		const DSPLIB_bufParams2D_t *	bufParamsOut,
		const DSPLIB_fir_InitArgs *	pKerInitArgs
	)

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of filter 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

DSPLIB_fir_exec()

DSPLIB_STATUS DSPLIB_fir_exec	(	DSPLIB_kernelHandle	handle,
		void *restrict	pIn,
		void *restrict	pFilter,
		void *restrict	pOut
	)

This function is the main kernel compute function.

Please refer to details under DSPLIB_fir

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn	: Pointer to buffer holding the input data
[in]	pFilter	: Pointer to buffer holding the filter 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_fir_init and DSPLIB_fir_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

DSPLIB_fir_exec_checkParams()

DSPLIB_STATUS DSPLIB_fir_exec_checkParams	(	DSPLIB_kernelHandle	handle,
		const void *restrict	pIn,
		const void *restrict	pFilter,
		const void *restrict	pOut
	)

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

Parameters

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

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

None

DSPLIB_fir_perfEst()

void DSPLIB_fir_perfEst	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsIn,
		const DSPLIB_bufParams1D_t *	bufParamsFilter,
		const DSPLIB_bufParams2D_t *	bufParamsOut,
		uint64_t *	archCycles,
		uint64_t *	estCycles
	)

This is a utility function that gives an estimate of the cycles consumed for the kernel execution.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of the input buffer
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of the filter buffer
[in]	bufParamsOut	: Pointer to the structure containing dimensional information of the output buffer
[out]	archCycles	: Cycles estimated for the compute, startup and teardown
[out]	estCycles	: Cycles estimated for the compute, startup, teardown and any associated overhead

Remarks

None