This section describes the SS/SSB transmit pipeline functions of the cuPHY application programming interface. More...

Data Structures
struct	_cuphyPerSsBlockDynPrms

struct	_cuphySsbDataIn

struct	_cuphySsbDataOut

struct	_cuphySsbDynPrms

struct	_cuphySsbStatPrms

Typedefs
typedef struct cuphySsbTx *	cuphySsbTxHndl_t

Functions
cuphyStatus_t	cuphyCreateSsbTx (cuphySsbTxHndl_t pSsbTxHndl, cuphySsbStatPrms_t const pStatPrms)
	Allocate and initialize a cuPHY SSB pipeline. More...

cuphyStatus_t	cuphyDestroySsbTx (cuphySsbTxHndl_t ssbTxHndl)
	Destroy a cuPHY SSB transmit pipeline object. More...

cuphyStatus_t	cuphyRunSsbTx (cuphySsbTxHndl_t ssbTxHndl, uint64_t procModeBmsk)
	Run cuPHY SSB pipeline processing in specified mode. More...

cuphyStatus_t	cuphySetupSsbTx (cuphySsbTxHndl_t ssbTxHndl, cuphySsbDynPrms_t *pDynPrms)
	Setup cuPHY SSB pipeline for slot processing. More...

Detailed Description

Typedef Documentation

◆ cuphySsbTxHndl_t

typedef struct cuphySsbTx* cuphySsbTxHndl_t

cuPHY PBCCH transmitter handle

Function Documentation

◆ cuphyCreateSsbTx()

cuphyStatus_t cuphyCreateSsbTx	(	cuphySsbTxHndl_t *	pSsbTxHndl,
		cuphySsbStatPrms_t const *	pStatPrms
	)

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

Returns CUPHY_STATUS_INVALID_ARGUMENT if pSsbTxHndl or pStatPrms is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a SsbTx object cannot be allocated

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters

pSsbTxHndl	- Address to return the new SsbTx 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,cuphySetupSsbTx,cuphyRunSsbTx,cuphyDestroySsbTx

◆ cuphyDestroySsbTx()

cuphyStatus_t cuphyDestroySsbTx ( cuphySsbTxHndl_t ssbTxHndl )

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

Returns CUPHY_STATUS_INVALID_ARGUMENT if ssbTxHndl is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters

ssbTxHndl - handle to previously allocated SsbTx instance

Returns: CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT

See also: cuphyStatus_t,cuphyCreateSsbTx

◆ cuphyRunSsbTx()

cuphyStatus_t cuphyRunSsbTx	(	cuphySsbTxHndl_t	ssbTxHndl,
		uint64_t	procModeBmsk
	)

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

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

Returns CUPHY_STATUS_SUCCESS if SsbTx execution is successful.

Parameters

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