fhi_lib/app/src/app_io_fh_xran.h

   1 /******************************************************************************
   2 *
   3 *   Copyright (c) 2020 Intel.
   4 *
   5 *   Licensed under the Apache License, Version 2.0 (the "License");
   6 *   you may not use this file except in compliance with the License.
   7 *   You may obtain a copy of the License at
   8 *
   9 *       http://www.apache.org/licenses/LICENSE-2.0
  10 *
  11 *   Unless required by applicable law or agreed to in writing, software
  12 *   distributed under the License is distributed on an "AS IS" BASIS,
  13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 *   See the License for the specific language governing permissions and
  15 *   limitations under the License.
  16 *
  17 *******************************************************************************/
  18
  19 /**
  20  * @brief Header file to interface implementation to ORAN FH from Application side
  21  * @file app_iof_fh_xran.h
  22  * @ingroup xran
  23  * @author Intel Corporation
  24  *
  25  **/
  26
  27 #ifndef _APP_IO_FH_H_
  28 #define _APP_IO_FH_H_
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <stdio.h>
  35 #include <unistd.h>
  36
  37 #include "config.h"
  38
  39 #include "xran_fh_o_du.h"
  40 #include "xran_pkt_up.h"
  41
  42 #define MAX_PKT_BURST (448+4) /* 4x14x8 */
  43 #define N_MAX_BUFFER_SEGMENT MAX_PKT_BURST
  44
  45 #define NUM_OF_SUBFRAME_PER_FRAME (10)
  46
  47 #define SW_FPGA_TOTAL_BUFFER_LEN 4*1024*1024*1024
  48 #define SW_FPGA_SEGMENT_BUFFER_LEN 1*1024*1024*1024
  49 #define SW_FPGA_FH_TOTAL_BUFFER_LEN 1*1024*1024*1024
  50 #define FPGA_TO_SW_PRACH_RX_BUFFER_LEN   (8192)
  51
  52 extern void*  app_io_xran_handle;
  53 extern struct xran_fh_init app_io_xran_fh_init;
  54 extern struct xran_fh_config  app_io_xran_fh_config[XRAN_PORTS_NUM];
  55
  56 typedef struct
  57 {
  58     uint32_t phaseFlag   :1;
  59     uint32_t NRARFCN     :22;
  60     uint32_t SULFreShift :1;
  61     uint32_t SULFlag     :1;
  62     uint32_t rsv         :7;
  63 } FPGAPhaseCompCfg;
  64
  65 typedef enum {
  66     XRANFTHTX_OUT = 0,
  67     XRANFTHTX_PRB_MAP_OUT,
  68     XRANFTHTX_SEC_DESC_OUT,
  69     XRANFTHRX_IN,
  70     XRANFTHRX_PRB_MAP_IN,
  71     XRANFTHTX_SEC_DESC_IN,
  72     XRANFTHRACH_IN,
  73     XRANSRS_IN,
  74     XRANSRS_PRB_MAP_IN,
  75     XRANSRS_SEC_DESC_IN,
  76     MAX_SW_XRAN_INTERFACE_NUM
  77 } SWXRANInterfaceTypeEnum;
  78
  79 struct xran_io_buf_ctrl {
  80     /* -1-this subframe is not used in current frame format
  81          0-this subframe can be transmitted, i.e., data is ready
  82           1-this subframe is waiting transmission, i.e., data is not ready
  83          10 - DL transmission missing deadline. When FE needs this subframe data but bValid is still 1,
  84         set bValid to 10.
  85     */
  86     int32_t bValid ; // when UL rx, it is subframe index.
  87     int32_t nSegToBeGen;
  88     int32_t nSegGenerated; // how many date segment are generated by DL LTE processing or received from FE
  89                        // -1 means that DL packet to be transmitted is not ready in BS
  90     int32_t nSegTransferred; // number of data segments has been transmitted or received
  91     struct rte_mbuf *pData[N_MAX_BUFFER_SEGMENT]; // point to DPDK allocated memory pool
  92     struct xran_buffer_list sBufferList;
  93 };
  94
  95 struct xran_io_shared_ctrl {
  96     /* io struct */
  97     struct xran_io_buf_ctrl sFrontHaulTxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
  98     struct xran_io_buf_ctrl sFrontHaulTxPrbMapBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
  99     struct xran_io_buf_ctrl sFrontHaulRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 100     struct xran_io_buf_ctrl sFrontHaulRxPrbMapBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 101     struct xran_io_buf_ctrl sFHPrachRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 102     struct xran_io_buf_ctrl sFHPrachRxBbuIoBufCtrlDecomp[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 103
 104     /* Cat B */
 105     struct xran_io_buf_ctrl sFHSrsRxBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR];
 106     struct xran_io_buf_ctrl sFHSrsRxPrbMapBbuIoBufCtrl[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR];
 107
 108     /* buffers lists */
 109     struct xran_flat_buffer sFrontHaulTxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT];
 110     struct xran_flat_buffer sFrontHaulTxPrbMapBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 111     struct xran_flat_buffer sFrontHaulRxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT];
 112     struct xran_flat_buffer sFrontHaulRxPrbMapBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR];
 113     struct xran_flat_buffer sFHPrachRxBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT];
 114     struct xran_flat_buffer sFHPrachRxBuffersDecomp[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANTENNA_NR][XRAN_NUM_OF_SYMBOL_PER_SLOT];
 115
 116     /* Cat B SRS buffers */
 117     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];
 118     struct xran_flat_buffer sFHSrsRxPrbMapBuffers[XRAN_N_FE_BUF_LEN][XRAN_MAX_SECTOR_NR][XRAN_MAX_ANT_ARRAY_ELM_NR];
 119 };
 120
 121 struct bbu_xran_io_if {
 122     void*    nInstanceHandle[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR]; /**< instance per ORAN port per CC */
 123     uint32_t nBufPoolIndex[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR][MAX_SW_XRAN_INTERFACE_NUM];  /**< unique buffer pool */
 124     uint16_t nInstanceNum[XRAN_PORTS_NUM]; /**< instance is equivalent to CC */
 125
 126     uint16_t DynamicSectionEna;
 127     uint32_t nPhaseCompFlag;
 128
 129     int32_t num_o_ru;
 130     int32_t num_cc_per_port[XRAN_PORTS_NUM];
 131     int32_t map_cell_id2port[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
 132
 133     struct xran_io_shared_ctrl ioCtrl[XRAN_PORTS_NUM]; /**< for each O-RU port */
 134
 135     struct xran_cb_tag  RxCbTag[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
 136     struct xran_cb_tag  PrachCbTag[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
 137     struct xran_cb_tag  SrsCbTag[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
 138 };
 139
 140 struct bbu_xran_io_if* app_io_xran_if_alloc(void);
 141 struct bbu_xran_io_if* app_io_xran_if_get(void);
 142 void app_io_xran_if_free(void);
 143 struct xran_io_shared_ctrl * app_io_xran_if_ctrl_get(uint32_t o_xu_id);
 144 int32_t app_io_xran_sfidx_get(uint8_t nNrOfSlotInSf);
 145
 146 int32_t app_io_xran_interface(uint32_t o_xu_id, RuntimeConfig *p_o_xu_cfg, UsecaseConfig* p_use_cfg);
 147 int32_t app_io_xran_iq_content_init(uint32_t o_xu_id, RuntimeConfig *p_o_xu_cfg);
 148 int32_t app_io_xran_iq_content_get(uint32_t o_xu_id, RuntimeConfig *p_o_xu_cfg);
 149 int32_t app_io_xran_eAxCid_conf_set(struct xran_eaxcid_config *p_eAxC_cfg, RuntimeConfig * p_s_cfg);
 150 int32_t app_io_xran_fh_config_init(UsecaseConfig* p_use_cfg,  RuntimeConfig* p_o_xu_cfg, struct xran_fh_init* p_xran_fh_init, struct xran_fh_config*  p_xran_fh_cfg);
 151 int32_t app_io_xran_fh_init_init(UsecaseConfig* p_use_cfg,  RuntimeConfig* p_o_xu_cfg, struct xran_fh_init* p_xran_fh_init);
 152 int32_t app_io_xran_buffers_max_sz_set (RuntimeConfig* p_o_xu_cfg);
 153
 154 int32_t app_io_xran_dl_tti_call_back(void * param);
 155 int32_t app_io_xran_ul_half_slot_call_back(void * param);
 156 int32_t app_io_xran_ul_full_slot_call_back(void * param);
 157 int32_t app_io_xran_ul_custom_sym_call_back(void * param, struct xran_sense_of_time* time);
 158
 159 void app_io_xran_if_stop(void);
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif /* _APP_IO_FH_H_ */
 166