PUCCH F1 receiver

This section describes the PUCCH F1 receiver functions of the cuPHY application programming interface. More...

Data Structures
struct	cuphyPucchF1RxLaunchCfg_t

Typedefs
typedef struct cuphyPucchF1Rx *	cuphyPucchF1RxHndl_t

Functions
cuphyStatus_t	cuphyCreatePucchF1Rx (cuphyPucchF1RxHndl_t *pPucchF1RxHndl, cudaStream_t strm)
	Allocate and initialize a cuPHY PucchF1Rx object. More...
cuphyStatus_t	cuphyDestroyPucchF1Rx (cuphyPucchF1RxHndl_t pucchF1RxHndl)
	Destroys a cuPHY PUCCH F1 receiver object. More...
cuphyStatus_t	cuphyPucchF1RxGetDescrInfo (size_t *pDynDescrSizeBytes, size_t *pDynDescrAlignBytes)
	Helper to compute cuPHY PUCCH F1 receiver descriptor buffer sizes and alignments. More...
cuphyStatus_t	cuphySetupPucchF1Rx (cuphyPucchF1RxHndl_t pucchF1RxHndl, cuphyTensorPrm_t *pDataRx, cuphyPucchF0F1UciOut_t *pF1UcisOut, uint16_t nCells, uint16_t nF1Ucis, cuphyPucchUciPrm_t *pF1UciPrms, cuphyPucchCellPrm_t *pCmnCellPrms, uint8_t enableCpuToGpuDescrAsyncCpy, void *pCpuDynDesc, void *pGpuDynDesc, cuphyPucchF1RxLaunchCfg_t *pLaunchCfg, cudaStream_t strm)
	Setup cuPHY PucchF1Rx for slot processing. More...

Detailed Description

Typedef Documentation

cuphyPucchF1RxHndl_t

typedef struct cuphyPucchF1Rx* cuphyPucchF1RxHndl_t

cuPHY PUCCH F1 receiver handle

Function Documentation

cuphyCreatePucchF1Rx()

cuphyStatus_t cuphyCreatePucchF1Rx	(	cuphyPucchF1RxHndl_t *	pPucchF1RxHndl,
		cudaStream_t	strm
	)

Allocates a cuPHY pucch F1 receiver object and returns a handle in the address provided by the caller.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPucchF1RxHndl is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a pucchF1Rx object cannot be allocated

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful

Parameters

pPucchF1RxHndl	- Address to return the new pucchF1Rx instance
strm	- CUDA stream for async copies

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_ALLOC_FAILED, CUPHY_STATUS_INVALID_ARGUMENT

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyPucchF1RxGetDescrInfo,cuphySetupPucchF1Rx

cuphyDestroyPucchF1Rx()

cuphyStatus_t cuphyDestroyPucchF1Rx

(

cuphyPucchF1RxHndl_t

pucchF1RxHndl

)

Destroys a cuPHY PUCCH F1 receiver object that was previously created by cuphyCreatePucchF1Rx. The handle provided to this function should not be used for any operations after this function returns.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pucchF1RxHndl is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters

pucchF1RxHndl

- handle to previously allocated pucchF1Rx instance

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyPucchF1RxGetDescrInfo,cuphyCreatePucchF1Rx,cuphySetupPucchF1Rx

cuphyPucchF1RxGetDescrInfo()

cuphyStatus_t cuphyPucchF1RxGetDescrInfo	(	size_t *	pDynDescrSizeBytes,
		size_t *	pDynDescrAlignBytes
	)

Computes cuPHY PUSCH PUCCH F1 receiver descriptor buffer sizes and alignments. To be used by the caller to allocate these buffers (in CPU and GPU memories) and provide them to other PucchF1Rx APIs

Returns CUPHY_STATUS_INVALID_ARGUMENT if pDynDescrSizeBytes and/or pDynDescrAlignBytes is NULL

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters

pDynDescrSizeBytes	- Size in bytes of dynamic descriptor
pDynDescrAlignBytes	- Alignment in bytes of dynamic descriptor

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyCreatePucchF1Rx,cuphyDestroyPucchF1Rx

cuphySetupPucchF1Rx()

cuphyStatus_t cuphySetupPucchF1Rx	(	cuphyPucchF1RxHndl_t	pucchF1RxHndl,
		cuphyTensorPrm_t *	pDataRx,
		cuphyPucchF0F1UciOut_t *	pF1UcisOut,
		uint16_t	nCells,
		uint16_t	nF1Ucis,
		cuphyPucchUciPrm_t *	pF1UciPrms,
		cuphyPucchCellPrm_t *	pCmnCellPrms,
		uint8_t	enableCpuToGpuDescrAsyncCpy,
		void *	pCpuDynDesc,
		void *	pGpuDynDesc,
		cuphyPucchF1RxLaunchCfg_t *	pLaunchCfg,
		cudaStream_t	strm
	)

Setup cuPHY PUCCH F1 receiver in preparation towards slot execution

Returns CUPHY_STATUS_SUCCESS if setup is successful.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pucchF1RxHndl and/or pDataRx and/or pF1UcisOut and/or pF1UciPrms and/or pCpuDynDesc and/or pGpuDynDesc is NULL.

Parameters

pucchF1RxHndl	- Handle to previously created PucchF1Rx instance
pDataRx	- Pointer to received data tensor parameters
pF1UcisOut	- Pointer to F1 uci output buffer
nCells	- Number of cells
nF1Ucis	- Number of F1 ucis to process
pF1UciPrms	- Pointer to F1 uci parameters
pCmnCellPrms	- Common cell parameters: number of gNB receive antennas, current slot number, gNB hopping ID
enableCpuToGpuDescrAsyncCpy	- Flag when set enables async copy of CPU descriptor into GPU
pCpuDynDesc	- Pointer to dynamic descriptor in CPU memory
pGpuDynDesc	- Pointer to dynamic descriptor in GPU memory
pLaunchCfg	- Pointer to channel estimation launch configurations
strm	- CUDA stream for descriptor copy operation

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyPucchF1RxGetDescrInfo,cuphyDestroyPucchF1Rx