This section describes the CSI-RS transmit pipeline functions of the cuPHY application programming interface. More...

Data Structures
struct	_cuphyCsirsCellDynPrm

struct	_cuphyCsirsDataOut

struct	_cuphyCsirsDynPrms

struct	_cuphyCsirsRrcDynPrm

struct	_cuphyCsirsStatPrms

Typedefs
typedef struct cuphyCsirsTx *	cuphyCsirsTxHndl_t

Functions
cuphyStatus_t	cuphyCreateCsirsTx (cuphyCsirsTxHndl_t pCsirsTxHndl, cuphyCsirsStatPrms_t const pStatPrms)
	Allocate and initialize a cuPHY CSI-RS pipeline. More...

cuphyStatus_t	cuphyDestroyCsirsTx (cuphyCsirsTxHndl_t csirsTxHndl)
	Destroy a cuPHY CSI-RS transmit pipeline object. More...

cuphyStatus_t	cuphyRunCsirsTx (cuphyCsirsTxHndl_t csirsTxHndl)
	Run cuPHY CSI-RS pipeline processing in specified mode. More...

cuphyStatus_t	cuphySetupCsirsTx (cuphyCsirsTxHndl_t csirsTxHndl, cuphyCsirsDynPrms_t *pDynPrms)
	Setup cuPHY CSI-RS pipeline for slot processing. More...

Detailed Description

Typedef Documentation

◆ cuphyCsirsTxHndl_t

typedef struct cuphyCsirsTx* cuphyCsirsTxHndl_t

cuPHY CSIRS transmitter handle

Function Documentation

◆ cuphyCreateCsirsTx()

cuphyStatus_t cuphyCreateCsirsTx	(	cuphyCsirsTxHndl_t *	pCsirsTxHndl,
		cuphyCsirsStatPrms_t const *	pStatPrms
	)

Allocate a cuPHY CSI-RS transmitter pipeline and return a handle in the address provided by the caller.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pCsirsTxHndl or pStatPrms is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a CsirsTx object cannot be allocated

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters

pCsirsTxHndl	- Address to return the new CsirsTx instance
pStatPrms	- Pointer to CSI-RS 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,cuphySetupCsirsTx,cuphyRunCsirsTx,cuphyDestroyCsirsTx

◆ cuphyDestroyCsirsTx()

cuphyStatus_t cuphyDestroyCsirsTx ( cuphyCsirsTxHndl_t csirsTxHndl )

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

Returns CUPHY_STATUS_INVALID_ARGUMENT if csirsTxHndl is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters

csirsTxHndl - handle to previously allocated csirsTx instance