DSPLIB_lud_priv.h File Reference

Introduction

Header file for kernel's internal use. For the kernel's interface, please see DSPLIB_lud.

Definition in file DSPLIB_lud_priv.h.

Go to the source code of this file.

Data Structures
struct	DSPLIB_lud_PrivArgs
	Structure that is reserved for internal use by the kernel. More...

Macros
#define	DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE   (22 * SE_PARAM_SIZE)
	Macro to define the size of bufPblock array of DSPLIB_lud_PrivArgs structure. More...

Typedefs
typedef DSPLIB_STATUS(*	pFxnDSPLIB_lud_exec) (DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
	This is a function pointer type that conforms to the declaration of DSPLIB_lud_exec_ci and DSPLIB_lud_exec_cn. More...

Functions
template<typename dataType >
DSPLIB_STATUS	DSPLIB_lud_init_ci (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_ludInitArgs *pKerInitArgs)
	This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_init. More...
template<typename dataType >
DSPLIB_STATUS	DSPLIB_lud_exec_ci (DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
	This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_exec. More...
DSPLIB_STATUS	DSPLIB_lud_init_cn (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_ludInitArgs *pKerInitArgs)
	This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_init. More...
template<typename dataType >
DSPLIB_STATUS	DSPLIB_lud_exec_cn (DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
	This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_exec. More...

Macro Definition Documentation

DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE

#define DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE   (22 * SE_PARAM_SIZE)

Macro to define the size of bufPblock array of DSPLIB_lud_PrivArgs structure.

Definition at line 38 of file DSPLIB_lud_priv.h.

Typedef Documentation

pFxnDSPLIB_lud_exec

typedef DSPLIB_STATUS(* pFxnDSPLIB_lud_exec) (DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)

This is a function pointer type that conforms to the declaration of DSPLIB_lud_exec_ci and DSPLIB_lud_exec_cn.

Definition at line 45 of file DSPLIB_lud_priv.h.

Function Documentation

DSPLIB_lud_init_ci()

template<typename dataType >

DSPLIB_STATUS DSPLIB_lud_init_ci	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsA,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_ludInitArgs *	pKerInitArgs
	)

This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_init.

This function determines the configuration for the streaming engine resources based on the function call parameters, and the configuration is saved in bufPBlock array. In the kernel call sequence, DSPLIB_lud_exec_ci would be called later independently by the application. When DSPLIB_lud_exec_ci runs, it merely retrieves the configuration from the bufPBlock and uses it to set up the hardware resources. This arrangement is so that DSPLIB_lud_exec_ci does not lose cycles to determine the hardware configuration.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsA	: Pointer to the structure containing dimensional information of input buffer A
[out]	bufParamsL	: Pointer to the structure containing dimensional information of output buffer L
[out]	bufParamsU	: Pointer to the structure containing dimensional information of output buffer U
[out]	bufParamsP	: Pointer to the structure containing dimensional information of output buffer P
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 59 of file DSPLIB_lud_ci.cpp.

DSPLIB_lud_exec_ci()

template<typename dataType >

DSPLIB_STATUS DSPLIB_lud_exec_ci	(	DSPLIB_kernelHandle	handle,
		void *restrict	pA,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pP
	)

This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_exec.

The function uses streaming engine to load data. The result is then stored at separate location using a streaming address generator.

Parameters

[in]	handle	: Active handle to the kernel
[in]	pA	: Pointer to matrix A
[out]	pL	: Pointer to lower triangular matrix L
[out]	pU	: Pointer to upper triangular matrix U
[out]	pP	: Pointer to permutation matrix P

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

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

Definition at line 976 of file DSPLIB_lud_ci.cpp.

DSPLIB_lud_init_cn()

DSPLIB_STATUS DSPLIB_lud_init_cn	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsA,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_ludInitArgs *	pKerInitArgs
	)

This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_init.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsA	: Pointer to the structure containing dimensional information of input buffer A
[out]	bufParamsL	: Pointer to the structure containing dimensional information of output buffer L
[out]	bufParamsU	: Pointer to the structure containing dimensional information of output buffer U
[out]	bufParamsP	: Pointer to the structure containing dimensional information of output buffer P
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 41 of file DSPLIB_lud_cn.cpp.

DSPLIB_lud_exec_cn()

template<typename dataType >

DSPLIB_STATUS DSPLIB_lud_exec_cn	(	DSPLIB_kernelHandle	handle,
		void *restrict	pA,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pP
	)

This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_lud_exec.

Parameters

[in]	handle	: Active handle to the kernel
[in]	pA	: Pointer to matrix A
[out]	pL	: Pointer to lower triangular matrix L
[out]	pU	: Pointer to upper triangular matrix U
[out]	pP	: Pointer to permutation matrix P

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 179 of file DSPLIB_lud_cn.cpp.