X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fstructxran__device__ctx.html;fp=docs%2FAPI%2Fstructxran__device__ctx.html;h=a4e0917910a9f0deb89b48a68a363cc499ed67b7;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/structxran__device__ctx.html b/docs/API/structxran__device__ctx.html new file mode 100644 index 0000000..a4e0917 --- /dev/null +++ b/docs/API/structxran__device__ctx.html @@ -0,0 +1,1088 @@ + + + + + + + +o-du/phy: xran_device_ctx Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Data Fields
+
+
xran_device_ctx Struct Reference
+
+
+ +

#include <xran_common.h>

+
+Collaboration diagram for xran_device_ctx:
+
+
Collaboration graph
+ + + + + + + + + + + + + + + + + +
+ + + + +

+Public Member Functions

 LIST_HEAD (sym_cb_elem_list, cb_elem_entry) sym_cb_list_head[XRAN_MAX_SECTOR_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

uint8_t sector_id
 
uint8_t xran_port_id
 
struct xran_eaxcid_config eAxc_id_cfg
 
struct xran_fh_init fh_init
 
struct xran_fh_config fh_cfg
 
struct xran_prach_cp_config PrachCPConfig
 
uint32_t enablePrach
 
uint32_t enableCP
 
int32_t DynamicSectionEna
 
int64_t offset_sec
 
int64_t offset_nsec
 
uint32_t enableSrs
 
struct xran_srs_config srs_cfg
 
BbuIoBufCtrlStruct sFrontHaulTxBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
 
BbuIoBufCtrlStruct sFrontHaulTxPrbMapBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
 
BbuIoBufCtrlStruct sFrontHaulRxBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
 
BbuIoBufCtrlStruct sFrontHaulRxPrbMapBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
 
BbuIoBufCtrlStruct sFHPrachRxBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
 
BbuIoBufCtrlStruct sFHSrsRxBbuIoBufCtrl [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR]
 
struct xran_flat_buffer sFrontHaulTxBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
struct xran_flat_buffer sFrontHaulTxPrbMapBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
struct xran_flat_buffer sFrontHaulRxBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
struct xran_flat_buffer sFrontHaulRxPrbMapBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
struct xran_flat_buffer sFHPrachRxBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
struct xran_flat_buffer sFHSrsRxBuffers [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR][XRAN_MAX_NUM_OF_SRS_SYMBOL_PER_SLOT]
 
xran_transport_callback_fn pCallback [XRAN_MAX_SECTOR_NR]
 
void * pCallbackTag [XRAN_MAX_SECTOR_NR]
 
xran_transport_callback_fn pPrachCallback [XRAN_MAX_SECTOR_NR]
 
void * pPrachCallbackTag [XRAN_MAX_SECTOR_NR]
 
xran_transport_callback_fn pSrsCallback [XRAN_MAX_SECTOR_NR]
 
void * pSrsCallbackTag [XRAN_MAX_SECTOR_NR]
 
int32_t sym_up
 
int32_t sym_up_ul
 
xran_fh_tti_callback_fn ttiCb [XRAN_CB_MAX]
 
void * TtiCbParam [XRAN_CB_MAX]
 
uint32_t SkipTti [XRAN_CB_MAX]
 
int xran2phy_mem_ready
 
int rx_packet_symb_tracker [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
int rx_packet_prach_tracker [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
 
int rx_packet_callback_tracker [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR]
 
int rx_packet_prach_callback_tracker [XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR]
 
int prach_start_symbol [XRAN_MAX_SECTOR_NR]
 
int prach_last_symbol [XRAN_MAX_SECTOR_NR]
 
int phy_tti_cb_done
 
struct rte_mempool * direct_pool
 
struct rte_mempool * indirect_pool
 
struct mbuf_table tx_mbufs [RTE_MAX_ETHPORTS]
 
struct xran_common_counters fh_counters
 
phy_encoder_poll_fn bbdev_enc
 
phy_decoder_poll_fn bbdev_dec
 
xran_ethdi_mbuf_send_fn send_cpmbuf2ring
 
xran_ethdi_mbuf_send_fn send_upmbuf2ring
 
+

Detailed Description

+
+

Definition at line 203 of file xran_common.h.

+

Member Function Documentation

+ +

◆ LIST_HEAD()

+ +
+
+ + + + + + + + + + + + + + + + + + +
LIST_HEAD (sym_cb_elem_list ,
cb_elem_entry  
)
+
+ +
+
+

Field Documentation

+ +

◆ bbdev_dec

+ +
+
+ + + + +
phy_decoder_poll_fn bbdev_dec
+
+

call back to poll BBDev decoder

+ +

Definition at line 274 of file xran_common.h.

+ +
+
+ +

◆ bbdev_enc

+ +
+
+ + + + +
phy_encoder_poll_fn bbdev_enc
+
+

call back to poll BBDev encoder

+ +

Definition at line 273 of file xran_common.h.

+ +
+
+ +

◆ direct_pool

+ +
+
+ + + + +
struct rte_mempool* direct_pool
+
+ +

Definition at line 267 of file xran_common.h.

+ +
+
+ +

◆ DynamicSectionEna

+ +
+
+ + + + +
int32_t DynamicSectionEna
+
+ +

Definition at line 215 of file xran_common.h.

+ +
+
+ +

◆ eAxc_id_cfg

+ +
+
+ + + + +
struct xran_eaxcid_config eAxc_id_cfg
+
+ +

Definition at line 207 of file xran_common.h.

+ +
+
+ +

◆ enableCP

+ +
+
+ + + + +
uint32_t enableCP
+
+ +

Definition at line 213 of file xran_common.h.

+ +
+
+ +

◆ enablePrach

+ +
+
+ + + + +
uint32_t enablePrach
+
+ +

Definition at line 212 of file xran_common.h.

+ +
+
+ +

◆ enableSrs

+ +
+
+ + + + +
uint32_t enableSrs
+
+ +

Definition at line 219 of file xran_common.h.

+ +
+
+ +

◆ fh_cfg

+ +
+
+ + + + +
struct xran_fh_config fh_cfg
+
+ +

Definition at line 209 of file xran_common.h.

+ +
+
+ +

◆ fh_counters

+ +
+
+ + + + +
struct xran_common_counters fh_counters
+
+ +

Definition at line 271 of file xran_common.h.

+ +
+
+ +

◆ fh_init

+ +
+
+ + + + +
struct xran_fh_init fh_init
+
+ +

Definition at line 208 of file xran_common.h.

+ +
+
+ +

◆ indirect_pool

+ +
+
+ + + + +
struct rte_mempool* indirect_pool
+
+ +

Definition at line 268 of file xran_common.h.

+ +
+
+ +

◆ offset_nsec

+ +
+
+ + + + +
int64_t offset_nsec
+
+ +

Definition at line 217 of file xran_common.h.

+ +
+
+ +

◆ offset_sec

+ +
+
+ + + + +
int64_t offset_sec
+
+ +

Definition at line 216 of file xran_common.h.

+ +
+
+ +

◆ pCallback

+ +
+
+ + + + +
xran_transport_callback_fn pCallback[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 238 of file xran_common.h.

+ +
+
+ +

◆ pCallbackTag

+ +
+
+ + + + +
void* pCallbackTag[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 239 of file xran_common.h.

+ +
+
+ +

◆ phy_tti_cb_done

+ +
+
+ + + + +
int phy_tti_cb_done
+
+ +

Definition at line 265 of file xran_common.h.

+ +
+
+ +

◆ pPrachCallback

+ +
+
+ + + + +
xran_transport_callback_fn pPrachCallback[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 241 of file xran_common.h.

+ +
+
+ +

◆ pPrachCallbackTag

+ +
+
+ + + + +
void* pPrachCallbackTag[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 242 of file xran_common.h.

+ +
+
+ +

◆ prach_last_symbol

+ +
+
+ + + + +
int prach_last_symbol[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 263 of file xran_common.h.

+ +
+
+ +

◆ prach_start_symbol

+ +
+
+ + + + +
int prach_start_symbol[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 262 of file xran_common.h.

+ +
+
+ +

◆ PrachCPConfig

+ +
+
+ + + + +
struct xran_prach_cp_config PrachCPConfig
+
+ +

Definition at line 210 of file xran_common.h.

+ +
+
+ +

◆ pSrsCallback

+ +
+
+ + + + +
xran_transport_callback_fn pSrsCallback[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 244 of file xran_common.h.

+ +
+
+ +

◆ pSrsCallbackTag

+ +
+
+ + + + +
void* pSrsCallbackTag[XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 245 of file xran_common.h.

+ +
+
+ +

◆ rx_packet_callback_tracker

+ +
+
+ + + + +
int rx_packet_callback_tracker[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 260 of file xran_common.h.

+ +
+
+ +

◆ rx_packet_prach_callback_tracker

+ +
+
+ + + + +
int rx_packet_prach_callback_tracker[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR]
+
+ +

Definition at line 261 of file xran_common.h.

+ +
+
+ +

◆ rx_packet_prach_tracker

+ +
+
+ + + + +
int rx_packet_prach_tracker[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 259 of file xran_common.h.

+ +
+
+ +

◆ rx_packet_symb_tracker

+ +
+
+ + + + +
int rx_packet_symb_tracker[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 258 of file xran_common.h.

+ +
+
+ +

◆ sector_id

+ +
+
+ + + + +
uint8_t sector_id
+
+ +

Definition at line 205 of file xran_common.h.

+ +
+
+ +

◆ send_cpmbuf2ring

+ +
+
+ + + + +
xran_ethdi_mbuf_send_fn send_cpmbuf2ring
+
+

callback to send mbufs of C-Plane packets to the ring

+ +

Definition at line 276 of file xran_common.h.

+ +
+
+ +

◆ send_upmbuf2ring

+ +
+
+ + + + +
xran_ethdi_mbuf_send_fn send_upmbuf2ring
+
+

callback to send mbufs of U-Plane packets to the ring

+ +

Definition at line 277 of file xran_common.h.

+ +
+
+ +

◆ sFHPrachRxBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFHPrachRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
+
+ +

Definition at line 226 of file xran_common.h.

+ +
+
+ +

◆ sFHPrachRxBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFHPrachRxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 234 of file xran_common.h.

+ +
+
+ +

◆ sFHSrsRxBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFHSrsRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR]
+
+ +

Definition at line 227 of file xran_common.h.

+ +
+
+ +

◆ sFHSrsRxBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFHSrsRxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR][XRAN_MAX_NUM_OF_SRS_SYMBOL_PER_SLOT]
+
+ +

Definition at line 236 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulRxBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFrontHaulRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
+
+ +

Definition at line 224 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulRxBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFrontHaulRxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 232 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulRxPrbMapBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFrontHaulRxPrbMapBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
+
+ +

Definition at line 225 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulRxPrbMapBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFrontHaulRxPrbMapBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 233 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulTxBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFrontHaulTxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
+
+

configuration of SRS

+ +

Definition at line 222 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulTxBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFrontHaulTxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 230 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulTxPrbMapBbuIoBufCtrl

+ +
+
+ + + + +
BbuIoBufCtrlStruct sFrontHaulTxPrbMapBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR]
+
+ +

Definition at line 223 of file xran_common.h.

+ +
+
+ +

◆ sFrontHaulTxPrbMapBuffers

+ +
+
+ + + + +
struct xran_flat_buffer sFrontHaulTxPrbMapBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT]
+
+ +

Definition at line 231 of file xran_common.h.

+ +
+
+ +

◆ SkipTti

+ +
+
+ + + + +
uint32_t SkipTti[XRAN_CB_MAX]
+
+ +

Definition at line 254 of file xran_common.h.

+ +
+
+ +

◆ srs_cfg

+ +
+
+ + + + +
struct xran_srs_config srs_cfg
+
+ +

Definition at line 220 of file xran_common.h.

+ +
+
+ +

◆ sym_up

+ +
+
+ + + + +
int32_t sym_up
+
+

when we start sym 0 of up with respect to OTA time as measured in symbols

+ +

Definition at line 249 of file xran_common.h.

+ +
+
+ +

◆ sym_up_ul

+ +
+
+ + + + +
int32_t sym_up_ul
+
+ +

Definition at line 250 of file xran_common.h.

+ +
+
+ +

◆ ttiCb

+ +
+
+ + + + +
xran_fh_tti_callback_fn ttiCb[XRAN_CB_MAX]
+
+ +

Definition at line 252 of file xran_common.h.

+ +
+
+ +

◆ TtiCbParam

+ +
+
+ + + + +
void* TtiCbParam[XRAN_CB_MAX]
+
+ +

Definition at line 253 of file xran_common.h.

+ +
+
+ +

◆ tx_mbufs

+ +
+
+ + + + +
struct mbuf_table tx_mbufs[RTE_MAX_ETHPORTS]
+
+ +

Definition at line 269 of file xran_common.h.

+ +
+
+ +

◆ xran2phy_mem_ready

+ +
+
+ + + + +
int xran2phy_mem_ready
+
+ +

Definition at line 256 of file xran_common.h.

+ +
+
+ +

◆ xran_port_id

+ +
+
+ + + + +
uint8_t xran_port_id
+
+ +

Definition at line 206 of file xran_common.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ +