PDCCH Transmitter

This section describes the PDCCH transmit pipeline functions of the cuPHY application programming interface. More...

Data Structures
struct	_cuphyPdcchCoresetDynPrm
struct	_cuphyPdcchDataIn
struct	_cuphyPdcchDataOut
struct	cuphyPdcchDciPrm_t
struct	_cuphyPdcchDynPrms
struct	_cuphyPdcchStatPrms

Typedefs
typedef struct cuphyPdcchTx *	cuphyPdcchTxHndl_t

Functions
cuphyStatus_t	cuphyCreatePdcchTx (cuphyPdcchTxHndl_t *pPdcchTxHndl, cuphyPdcchStatPrms_t const *pStatPrms)
	Allocate and initialize a cuPHY PDCCH pipeline. More...
cuphyStatus_t	cuphyDestroyPdcchTx (cuphyPdcchTxHndl_t pdcchTxHndl)
	Destroy a cuPHY PDCCH transmit pipeline object. More...
cuphyStatus_t	cuphyRunPdcchTx (cuphyPdcchTxHndl_t pdcchTxHndl, uint64_t procModeBmsk)
	Run cuPHY PDCCH pipeline processing in specified mode. More...
cuphyStatus_t	cuphySetupPdcchTx (cuphyPdcchTxHndl_t pdcchTxHndl, cuphyPdcchDynPrms_t *pDynPrms)
	Setup cuPHY PDCCH pipeline for slot processing. More...

Detailed Description

Typedef Documentation

cuphyPdcchTxHndl_t

typedef struct cuphyPdcchTx* cuphyPdcchTxHndl_t

cuPHY PDCCH transmitter handle

Function Documentation

cuphyCreatePdcchTx()

cuphyStatus_t cuphyCreatePdcchTx	(	cuphyPdcchTxHndl_t *	pPdcchTxHndl,
		cuphyPdcchStatPrms_t const *	pStatPrms
	)

Allocate a cuPHY PDCCH transmitter pipeline and return a handle in the address provided by the caller.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPdcchTxHdnl or pStatPrms is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a PdcchTx object cannot be allocated

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters

pPdcchTxHndl	- Address to return the new PdcchTx instance
pStatPrms	- Pointer to PDCCH static parameters to be used in pipeline creation

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_ALLOC_FAILED, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphySetupPdcchTx,cuphyRunPdcchTx,cuphyDestroyPdcchTx

cuphyDestroyPdcchTx()

cuphyStatus_t cuphyDestroyPdcchTx

(

cuphyPdcchTxHndl_t

pdcchTxHndl

)

Destroy a cuPHY PDCCH transmitter pipeline object that was previously created by cuphyCreatePdcchTx. The handle provided to this function should not be used for any operations after this function returns.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pdcchTxHndl is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters

pdcchTxHndl

- handle to previously allocated PdcchTx instance

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyCreatePdcchTx

cuphyRunPdcchTx()

cuphyStatus_t cuphyRunPdcchTx	(	cuphyPdcchTxHndl_t	pdcchTxHndl,
		uint64_t	procModeBmsk
	)

Call triggers cuPHY PDCCH transmitter pipeline execution in mode specified by procModeBmsk

Returns CUPHY_STATUS_INVALID_ARGUMENT if pdcchTxHndl is NULL and/or procModeBmsk is not supported.

Returns CUPHY_STATUS_SUCCESS if PdcchTx execution is successful.

Parameters

pdcchTxHndl	- Handle of PdcchTx instance which is to be triggered
procModeBmsk	- Processing mode bitmask containing one or more processing modes applicable during this execution. Currently unused.

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyCreatePdcchTx,cuphySetupPdcchTx,cuphyDestroyPdcchTx

cuphySetupPdcchTx()

cuphyStatus_t cuphySetupPdcchTx	(	cuphyPdcchTxHndl_t	pdcchTxHndl,
		cuphyPdcchDynPrms_t *	pDynPrms
	)

Setup cuPHY PDCCH transmitter pipeline (and its components) state in preparation towards slot execution

Returns CUPHY_STATUS_INVALID_ARGUMENT if pdcchTxHndl and/or pDynPrms is NULL

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters

pdcchTxHndl	- Handle of PdcchTx instance to be setup
pDynPrms	- Dynamic parameters carrying information needed for slot processing

Returns

CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also

cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyCreatePdcchTx,cuphyRunPdcchTx,cuphyDestroyPdcchTx