DSPLIB_fltoq15

Introduction

This Kernel converts the IEEE floating point numbers stored in vector pIn into Q.15 format numbers and stores in vector pOut.

• If the integral part of the floating point number in EVEN and the factional part is "0.5" then the conversion to integer type is ROUNDED DOWN
• In all other cases the conversion to integer type is ROUNDED UP
• Values that exceed the size limit will be saturated to 0x7fff if value is positive and 0x8000 if value is negative
• The kernel support computation of vectors of several inputs in one kernel call

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

Functions
int32_t	DSPLIB_fltoq15_getHandleSize (DSPLIB_fltoq15_InitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...
DSPLIB_STATUS	DSPLIB_fltoq15_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_fltoq15_InitArgs *pKerInitArgs)
	This function checks the validity of the parameters passed to DSPLIB_fltoq15_init function. This function is called with the same parameters as the DSPLIB_fltoq15_init, and this function must be called before the DSPLIB_fltoq15_init is called. More...
DSPLIB_STATUS	DSPLIB_fltoq15_init (DSPLIB_kernelHandle handle, DSPLIB_bufParams1D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_fltoq15_InitArgs *pKerInitArgs)
	This function should be called before the DSPLIB_fltoq15_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 the streaming engine and streaming address generator. The results of these operations are stored in the handle. More...
DSPLIB_STATUS	DSPLIB_fltoq15_exec_checkParams (DSPLIB_kernelHandle handle, const void *restrict pIn, const void *restrict pOut)
	This function checks the validity of the parameters passed to DSPLIB_fltoq15_exec function. This function is called with the same parameters as the DSPLIB_fltoq15_init, and this function must be called before the DSPLIB_fltoq15_init is called. More...
DSPLIB_STATUS	DSPLIB_fltoq15_exec (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
	This function is the main kernel compute function. More...

Function Documentation

DSPLIB_fltoq15_getHandleSize()

int32_t DSPLIB_fltoq15_getHandleSize

(

DSPLIB_fltoq15_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_fltoq15.cpp.

DSPLIB_fltoq15_init_checkParams()

DSPLIB_STATUS DSPLIB_fltoq15_init_checkParams	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams1D_t *	bufParamsIn,
		const DSPLIB_bufParams1D_t *	bufParamsOut,
		const DSPLIB_fltoq15_InitArgs *	pKerInitArgs
	)

This function checks the validity of the parameters passed to DSPLIB_fltoq15_init function. This function is called with the same parameters as the DSPLIB_fltoq15_init, and this function must be called before the DSPLIB_fltoq15_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 34 of file DSPLIB_fltoq15.cpp.

DSPLIB_fltoq15_init()

DSPLIB_STATUS DSPLIB_fltoq15_init	(	DSPLIB_kernelHandle	handle,
		DSPLIB_bufParams1D_t *	bufParamsIn,
		DSPLIB_bufParams1D_t *	bufParamsOut,
		const DSPLIB_fltoq15_InitArgs *	pKerInitArgs
	)

This function should be called before the DSPLIB_fltoq15_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 the streaming engine and streaming address generator. 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 82 of file DSPLIB_fltoq15.cpp.

DSPLIB_fltoq15_exec_checkParams()

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

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn	: Pointer to the structure input buffer
[out]	pout	: Pointer to the output buffer

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

None

Definition at line 65 of file DSPLIB_fltoq15.cpp.

DSPLIB_fltoq15_exec()

DSPLIB_STATUS DSPLIB_fltoq15_exec	(	DSPLIB_kernelHandle	handle,
		void *restrict	pIn,
		void *restrict	pOut
	)

This function is the main kernel compute function.

Please refer to details under DSPLIB_fltoq15_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_fltoq15_init and DSPLIB_fltoq15_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 128 of file DSPLIB_fltoq15.cpp.