cuPHY  0.1
CUDA PHY Layer Acceration Library
Data Structures | Macros | Typedefs | Enumerations | Functions
PRACH Receiver

This section describes the structs and functions of the uplink cuPHY PRACH channel receiver. More...

Data Structures

struct  _cuphyPrachCellStatPrms
 Cell specific static parameters for PRACH receiver processing. More...
 
struct  _cuphyPrachDataIn
 
struct  _cuphyPrachDataOut
 
struct  _cuphyPrachDynPrms
 
struct  _cuphyPrachOccaDynPrms
 PRACH Occasions Dynamic Parameters. More...
 
struct  _cuphyPrachOccaStatPrms
 PRACH Occasions Static Parameter. More...
 
struct  _cuphyPrachStatPrms
 Static parameters to process all cell-group PRACH receiver. More...
 

Macros

#define CUPHY_PRACH_RX_NUM_PREAMBLE   (64)
 

Typedefs

typedef struct cuphyPrachRx * cuphyPrachRxHndl_t
 

Enumerations

enum  _cuphyPrachRxProcMode { ,
  PRACH_PROC_MODE_WITH_GRAPH = 0x1,
  PRACH_MAX_PROC_MODES
}
 PRACH processing modes. More...
 

Functions

cuphyStatus_t cuphyCreatePrachRx (cuphyPrachRxHndl_t *pPrachRxHndl, cuphyPrachStatPrms_t const *pStatPrms)
 Allocate and initialize a cuPHY PRACH pipeline. More...
 
cuphyStatus_t cuphyDestroyPrachRx (cuphyPrachRxHndl_t pPrachRxHndl)
 Destroy a cuPHY PRACH receiver pipeline object. More...
 
cuphyStatus_t cuphyRunPrachRx (cuphyPrachRxHndl_t pPrachRxHndl)
 Run cuPHY PRACH pipeline processing in specified mode. More...
 
cuphyStatus_t cuphySetupPrachRx (cuphyPrachRxHndl_t pPrachRxHndl, cuphyPrachDynPrms_t *pDynPrms)
 Setup cuPHY PRACH pipeline for slot processing. More...
 

Detailed Description

Macro Definition Documentation

◆ CUPHY_PRACH_RX_NUM_PREAMBLE

#define CUPHY_PRACH_RX_NUM_PREAMBLE   (64)

Maximum number of PRACH preambles

Typedef Documentation

◆ cuphyPrachRxHndl_t

typedef struct cuphyPrachRx* cuphyPrachRxHndl_t

cuPHY PRACH receiver handle

Enumeration Type Documentation

◆ _cuphyPrachRxProcMode

Enumerator
PRACH_PROC_MODE_WITH_GRAPH 

stream based workload submission

PRACH_MAX_PROC_MODES 

CUDA graph based workload submission.

Function Documentation

◆ cuphyCreatePrachRx()

cuphyStatus_t cuphyCreatePrachRx ( cuphyPrachRxHndl_t pPrachRxHndl,
cuphyPrachStatPrms_t const *  pStatPrms 
)

Allocate a cuPHY PRACH receiver pipeline and returns a handle in the address provided by the caller.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPrachRxHndl and/or pStatPrms is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a PrachRx object cannot be allocated

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters
pPrachRxHndl- Address to return the new PrachRx instance
pStatPrms- Pointer to PRACH 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,cuphySetupPrachRx,cuphyRunPrachRx,cuphyDestroyPrachRx

◆ cuphyDestroyPrachRx()

cuphyStatus_t cuphyDestroyPrachRx ( cuphyPrachRxHndl_t  pPrachRxHndl)

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

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPrachRxHndl is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters
pPrachRxHndl- handle to previously allocated prachRx instance
Returns
CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT
See also
cuphyStatus_t,cuphyCreatePrachRx

◆ cuphyRunPrachRx()

cuphyStatus_t cuphyRunPrachRx ( cuphyPrachRxHndl_t  pPrachRxHndl)

Call triggers cuPHY PRACH transmitter pipeline execution

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPrachRxHndl

Returns CUPHY_STATUS_SUCCESS if PrachRx execution is successful.

Parameters
pPrachRxHndl- Handle of PrachRx instance which is to be triggered
Returns
CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT
See also
cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyCreatePrachRx,cuphySetupPrachRx,cuphyDestroyPrachRx

◆ cuphySetupPrachRx()

cuphyStatus_t cuphySetupPrachRx ( cuphyPrachRxHndl_t  pPrachRxHndl,
cuphyPrachDynPrms_t *  pDynPrms 
)

Setup cuPHY PRACH receiver pipeline (and its components) state in preparation towards slot execution

Returns CUPHY_STATUS_INVALID_ARGUMENT if pPrachRxHndl and/or pDynPrms is NULL

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters
pPrachRxHndl- Handle of prachRx 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,cuphyCreatePrachRx,cuphyRunPrachRx,cuphyDestroyPrachRx