Introduction

Kernel for computing DFT for small number of points using brute-force matrix multiplication.

The size of data for each channel in the batch is assumed to be less than or equal to (MMA vector width)/2.
The size of data is not required to be a power of 2.
The kernel requires application to provide a pre-generated DFT computational matrix along with the input data.

Data Structures
struct	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs
	Structure containing the parameters for DFT computation. More...

Functions
int32_t	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize (FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes (const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs pKerInitArgs, FFTLIB_bufParams1D_t bufParamsX, FFTLIB_bufParams1D_t bufParamsW, FFTLIB_bufParams1D_t bufParamsY)
	This is a query function to calculate the sizes of input, output and the DFT computational matrix buffers. More...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen (const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs pKerInitArgs, void pW, const FFTLIB_bufParams1D_t *bufParamsW)
	This is a utility function that generates the DFT computational matrix into the provided buffer. More...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init (FFTLIB_kernelHandle handle, FFTLIB_bufParams1D_t bufParamsX, FFTLIB_bufParams1D_t bufParamsW, FFTLIB_bufParams1D_t bufParamsY, FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs pKerInitArgs)
	This function should be called before the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_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...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams (FFTLIB_kernelHandle handle, const FFTLIB_bufParams1D_t bufParamsX, const FFTLIB_bufParams1D_t bufParamsW, const FFTLIB_bufParams1D_t bufParamsY, const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs pKerInitArgs)
	This function checks the validity of the parameters passed to FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init function. This function is called with the same parameters as the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init, and this function must be called before the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init is called. More...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec (FFTLIB_kernelHandle handle, void restrict pX, void restrict pW, void *restrict pY)
	This function is the main kernel compute function. More...

FFTLIB_STATUS	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams (FFTLIB_kernelHandle handle, const void restrict pX, const void restrict pW, const void *restrict pY)
	This function checks the validity of the parameters passed to FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec function. This function is called with the same parameters as the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec, and this function must be called before the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec is called. More...

void	FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst (FFTLIB_kernelHandle handle, const FFTLIB_bufParams1D_t bufParamsX, const FFTLIB_bufParams1D_t bufParamsY, const FFTLIB_bufParams1D_t bufParamsW, uint32_t fftSize, uint32_t batchSize, uint64_t archCycles, uint64_t *estCycles)
	This is a utility function that gives an estimate of the cycles consumed for the kernel execution. More...

Macros
#define	FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS 1
	Macro to define the number of bit-shifts that are to be provided for use in the internal DFT computation. More...

Macro Definition Documentation

◆ FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS

#define FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS 1

Macro to define the number of bit-shifts that are to be provided for use in the internal DFT computation.

The number of bit-shifts depends on the number of stages of computation. This kernel has only one stage of computation.

Definition at line 111 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h.

Function Documentation

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize()

int32_t FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize ( FFTLIB_FFT_dftSmall_ixX_cxX_oxX_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 FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes	(	const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *	pKerInitArgs,
		FFTLIB_bufParams1D_t *	bufParamsX,
		FFTLIB_bufParams1D_t *	bufParamsW,
		FFTLIB_bufParams1D_t *	bufParamsY
	)

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

Parameters

[in]	pKerInitArgs	: Pointer to the structure holding init parameters
[in]	bufParamsX	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsW	: Pointer to the structure containing dimensional information of DFT computational matrix buffer
[in]	bufParamsY	: Pointer to the structure containing dimensional information of ouput buffer

Returns: Status value indicating success or failure. Refer to FFTLIB_STATUS.

Remarks: Application is expected to allocate buffers of the requested size, fill in the input data and DFT computational matrix data before making the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec function call.

Definition at line 125 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX_ci.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen	(	const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *	pKerInitArgs,
		void *	pW,
		const FFTLIB_bufParams1D_t *	bufParamsW
	)

This is a utility function that generates the DFT computational matrix into the provided buffer.

Parameters

[in]	pKerInitArgs	: Pointer to the structure holding init parameters
[in]	pW	: Pointer to the buffer where the DFT computational matrix is generated into.
[in]	bufParamsW	: Pointer to the structure containing dimensional information of DFT computational matrix buffer

Returns: Status value indicating success or failure. Refer to FFTLIB_STATUS.

Remarks: pW must point to a buffer of size obtained from the call to FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes function.

Definition at line 119 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init	(	FFTLIB_kernelHandle	handle,
		FFTLIB_bufParams1D_t *	bufParamsX,
		FFTLIB_bufParams1D_t *	bufParamsW,
		FFTLIB_bufParams1D_t *	bufParamsY,
		FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *	pKerInitArgs
	)

This function should be called before the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_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]	bufParamsX	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsW	: Pointer to the structure containing dimensional information of DFT computational matrix buffer
[out]	bufParamsY	: 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 FFTLIB_STATUS.

Remarks: Application is expected to provide a valid handle.

Definition at line 141 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams	(	FFTLIB_kernelHandle	handle,
		const FFTLIB_bufParams1D_t *	bufParamsX,
		const FFTLIB_bufParams1D_t *	bufParamsW,
		const FFTLIB_bufParams1D_t *	bufParamsY,
		const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *	pKerInitArgs
	)

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsX	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsW	: Pointer to the structure containing dimensional information of DFT computational matrix
[out]	bufParamsY	: 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 FFTLIB_STATUS.

Remarks: None

Definition at line 32 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec	(	FFTLIB_kernelHandle	handle,
		void *restrict	pX,
		void *restrict	pW,
		void *restrict	pY
	)

This function is the main kernel compute function.

Please refer to details under FFTLIB_FFT_dftSmall_ixX_cxX_oxX

Parameters

[in]	handle	: Active handle to the kernel
[in]	pX	: Pointer to buffer holding the input data
[in]	pW	: Pointer to buffer holding the DFT computational matrix
[out]	pY	: Pointer to buffer holding the output data

Returns: Status value indicating success or failure. Refer to FFTLIB_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 FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init and FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 205 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams()

FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams	(	FFTLIB_kernelHandle	handle,
		const void *restrict	pX,
		const void *restrict	pW,
		const void *restrict	pY
	)

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	pX	: Pointer to buffer holding the input data
[in]	pW	: Pointer to buffer holding the DFT computational matrix
[out]	pY	: Pointer to buffer holding the output matrix

Returns: Status value indicating success or failure. Refer to FFTLIB_STATUS.

Remarks: None

Definition at line 77 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp.

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst()

void FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst	(	FFTLIB_kernelHandle	handle,
		const FFTLIB_bufParams1D_t *	bufParamsX,
		const FFTLIB_bufParams1D_t *	bufParamsY,
		const FFTLIB_bufParams1D_t *	bufParamsW,
		uint32_t	fftSize,
		uint32_t	batchSize,
		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]	bufParamsX	: Pointer to the structure containing dimensional information of pX
[in]	bufParamsY	: Pointer to the structure containing dimensional information of pY
[in]	bufParamsW	: Pointer to the structure containing dimensional information of pW
[in]	fftSize	: Size of each channel's data in terms of number of complex points
[in]	batchSize	: Size of the batch in terms of number of channels of DFT's
[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

Definition at line 64 of file FFTLIB_FFT_dftSmall_ixX_cxX_oxX_ci.cpp.

Introduction

Data Structures

Functions

Macros

Macro Definition Documentation

◆ FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS

Function Documentation

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams()

◆ FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst()