fix(ldpc-decoding-module-interface-rework): fixes module name, nr_ulsim help,...

fix(ldpc-decoding-module-interface-rework): fixes module name, nr_ulsim help, demo module function naming and loading encoder

CMakeLists.txt

@@ -893,7 +893,7 @@ add_library(coding MODULE ${PHY_TURBOSRC} )
 
 add_library(dfts MODULE ${OPENAIR1_DIR}/PHY/TOOLS/oai_dfts.c ${OPENAIR1_DIR}/PHY/TOOLS/oai_dfts_neon.c)
 
-add_library(_nr_ulsch_decoding_interface_demo MODULE ${PHY_NR_ULSCH_DECODING_DEMO_SRC})
+add_library(nr_ulsch_decoding_interface_demo MODULE ${PHY_NR_ULSCH_DECODING_DEMO_SRC})
 
 set(PHY_SRC_COMMON
   ${OPENAIR1_DIR}/PHY/LTE_TRANSPORT/dci_tools_common.c
@@ -2321,7 +2321,7 @@ add_executable(nr_ulsim
 if (ENABLE_LDPC_T2)
   add_dependencies(nr_ulsim ldpc_t2)
 endif()
-add_dependencies(nr_ulsim _nr_ulsch_decoding_interface_demo)
+add_dependencies(nr_ulsim nr_ulsch_decoding_interface_demo)
 
 target_link_libraries(nr_ulsim PRIVATE
   -Wl,--start-group UTIL SIMU SIMU_ETH PHY_COMMON PHY_NR_COMMON PHY_NR PHY_NR_UE SCHED_NR_LIB SCHED_NR_UE_LIB MAC_UE_NR MAC_NR_COMMON nr_rrc CONFIG_LIB L2_NR HASHTABLE x2ap SECURITY ngap -lz -Wl,--end-group
@@ -2388,7 +2388,7 @@ if (${T_TRACER})
         PHY_COMMON PHY PHY_UE PHY_NR PHY_NR_COMMON PHY_NR_UE PHY_RU PHY_MEX
         L2 L2_LTE L2_NR L2_LTE_NR L2_UE NR_L2_UE L2_UE_LTE_NR MAC_NR_COMMON MAC_UE_NR ngap
         CN_UTILS GTPV1U SCTP_CLIENT MME_APP LIB_NAS_UE NB_IoT SIMU SIMU_ETH OPENAIR0_LIB
-        ldpc_orig ldpc_optim ldpc_optim8seg ldpc_t2 ldpc_cl ldpc_cuda ldpc _nr_ulsch_decoding_interface_demo dfts config_internals)
+        ldpc_orig ldpc_optim ldpc_optim8seg ldpc_t2 ldpc_cl ldpc_cuda ldpc nr_ulsch_decoding_interface_demo dfts config_internals)
     if (TARGET ${i})
       add_dependencies(${i} generate_T)
     endif()

openair1/PHY/CODING/nr_ulsch_decoding_interface_demo.c

@@ -191,101 +191,6 @@ static void nr_processULSegment_demo(void *arg)
     memcpy(ulsch_harq->c[r],llrProcBuf,  Kr>>3);
 }
 
-int decode_offload_demo(PHY_VARS_gNB *phy_vars_gNB,
-                   uint8_t ULSCH_id,
-                   short *ulsch_llr,
-                   nfapi_nr_pusch_pdu_t *pusch_pdu,
-                   t_nrLDPC_dec_params *decParams,
-                   uint8_t harq_pid,
-                   uint32_t G)
-{
-  NR_gNB_ULSCH_t *ulsch = &phy_vars_gNB->ulsch[ULSCH_id];
-  NR_UL_gNB_HARQ_t *harq_process = ulsch->harq_process;
-  int16_t z_ol[LDPC_MAX_CB_SIZE] __attribute__((aligned(16)));
-  int8_t l_ol[LDPC_MAX_CB_SIZE] __attribute__((aligned(16)));
-  uint8_t Qm = pusch_pdu->qam_mod_order;
-  uint8_t n_layers = pusch_pdu->nrOfLayers;
-  const int Kr = harq_process->K;
-  const int Kr_bytes = Kr >> 3;
-  uint32_t A = (harq_process->TBS) << 3;
-  const int kc = decParams->BG == 2 ? 52 : 68;
-  ulsch->max_ldpc_iterations = 20;
-  int decodeIterations = 2;
-  int r_offset = 0, offset = 0;
-  for (int r = 0; r < harq_process->C; r++) {
-    int E = nr_get_E(G, harq_process->C, Qm, n_layers, r);
-    memset(harq_process->c[r], 0, Kr_bytes);
-    decParams->R = nr_get_R_ldpc_decoder(pusch_pdu->pusch_data.rv_index,
-                                         E,
-                                         decParams->BG,
-                                         decParams->Z,
-                                         &harq_process->llrLen,
-                                         harq_process->round);
-
-    memcpy(z_ol, ulsch_llr + r_offset, E * sizeof(short));
-    simde__m128i *pv_ol128 = (simde__m128i *)&z_ol;
-    simde__m128i *pl_ol128 = (simde__m128i *)&l_ol;
-    for (int i = 0, j = 0; j < ((kc * harq_process->Z) >> 4) + 1; i += 2, j++) {
-      pl_ol128[j] = simde_mm_packs_epi16(pv_ol128[i], pv_ol128[i + 1]);
-    }
-    decParams->E = E;
-    decParams->rv = pusch_pdu->pusch_data.rv_index;
-    decParams->F = harq_process->F;
-    decParams->Qm = Qm;
-    decodeIterations =
-        ldpc_interface_offload_demo
-            .LDPCdecoder(decParams, harq_pid, ULSCH_id, r, (int8_t *)&pl_ol128[0], (int8_t *)harq_process->c[r], NULL, NULL);
-    if (decodeIterations < 0) {
-      LOG_E(PHY, "ulsch_decoding.c: Problem in LDPC decoder offload\n");
-      return -1;
-    }
-    bool decodeSuccess = check_crc((uint8_t *)harq_process->c[r], lenWithCrc(harq_process->C, A), crcType(harq_process->C, A));
-    if (decodeSuccess) {
-      memcpy(harq_process->b + offset, harq_process->c[r], Kr_bytes - (harq_process->F >> 3) - ((harq_process->C > 1) ? 3 : 0));
-      offset += (Kr_bytes - (harq_process->F >> 3) - ((harq_process->C > 1) ? 3 : 0));
-      harq_process->processedSegments++;
-    } else {
-      LOG_D(PHY, "uplink segment error %d/%d\n", r, harq_process->C);
-      LOG_D(PHY, "ULSCH %d in error\n", ULSCH_id);
-    }
-    r_offset += E;
-  }
-  bool crc_valid = false;
-  if (harq_process->processedSegments == harq_process->C) {
-    // When the number of code blocks is 1 (C = 1) and ulsch_harq->processedSegments = 1, we can assume a good TB because of the
-    // CRC check made by the LDPC for early termination, so, no need to perform CRC check twice for a single code block
-    crc_valid = true;
-    if (harq_process->C > 1) {
-      crc_valid = check_crc(harq_process->b, lenWithCrc(1, A), crcType(1, A));
-    }
-  }
-  if (crc_valid) {
-    LOG_D(PHY, "ULSCH: Setting ACK for slot %d TBS %d\n", ulsch->slot, harq_process->TBS);
-    ulsch->active = false;
-    harq_process->round = 0;
-    LOG_D(PHY, "ULSCH received ok \n");
-    nr_fill_indication(phy_vars_gNB, ulsch->frame, ulsch->slot, ULSCH_id, harq_pid, 0, 0);
-  } else {
-    LOG_D(PHY,
-        "[gNB %d] ULSCH: Setting NAK for SFN/SF %d/%d (pid %d, status %d, round %d, TBS %d)\n",
-        phy_vars_gNB->Mod_id,
-        ulsch->frame,
-        ulsch->slot,
-        harq_pid,
-        ulsch->active,
-        harq_process->round,
-        harq_process->TBS);
-    ulsch->handled = 1;
-    decodeIterations = ulsch->max_ldpc_iterations + 1;
-    LOG_D(PHY, "ULSCH %d in error\n", ULSCH_id);
-    nr_fill_indication(phy_vars_gNB, ulsch->frame, ulsch->slot, ULSCH_id, harq_pid, 1, 0);
-  }
-
-  ulsch->last_iteration_cnt = decodeIterations;
-  VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_PHY_gNB_ULSCH_DECODING,0);
-  return 0;
-}
-
 int nr_ulsch_decoding_demo(PHY_VARS_gNB *phy_vars_gNB,
                       uint8_t ULSCH_id,
                       short *ulsch_llr,
@@ -396,9 +301,6 @@ int nr_ulsch_decoding_demo(PHY_VARS_gNB *phy_vars_gNB,
     harq_process->harq_to_be_cleared = false;
   }
 
-  if (phy_vars_gNB->ldpc_offload_flag)
-    return decode_offload_demo(phy_vars_gNB, ULSCH_id, ulsch_llr, pusch_pdu, &decParams, harq_pid, G);
-
   uint32_t offset = 0, r_offset = 0;
   set_abort(&harq_process->abort_decode, false);
   for (int r = 0; r < harq_process->C; r++) {
@@ -438,17 +340,15 @@ int nr_ulsch_decoding_demo(PHY_VARS_gNB *phy_vars_gNB,
   return harq_process->C;
 }
 
-int32_t nr_ulsch_procedures_init(void){
+int32_t nr_ulsch_decoding_init(void){
 
   load_LDPClib(NULL, &ldpc_interface_demo);
 
-  load_LDPClib("_t2", &ldpc_interface_offload_demo);
-
   return 0;
 
 }
 
-int32_t nr_ulsch_procedures_shutdown(void){
+int32_t nr_ulsch_decoding_shutdown(void){
 
   free_LDPClib(&ldpc_interface_demo);
 
@@ -458,7 +358,7 @@ int32_t nr_ulsch_procedures_shutdown(void){
 
 }
 
-int32_t nr_ulsch_procedures_decoder(PHY_VARS_gNB *gNB, NR_DL_FRAME_PARMS *frame_parms, int frame_rx, int slot_rx, uint32_t *G){
+int32_t nr_ulsch_decoding_decoder(PHY_VARS_gNB *gNB, NR_DL_FRAME_PARMS *frame_parms, int frame_rx, int slot_rx, uint32_t *G){
 
   int nbDecode = 0;
   for (int ULSCH_id = 0; ULSCH_id < gNB->max_nb_pusch; ULSCH_id++) {

openair1/PHY/INIT/nr_init.c

@@ -133,12 +133,12 @@ int phy_init_nr_gNB(PHY_VARS_gNB *gNB)
 
   if (gNB->nr_ulsch_decoding_interface_flag){
     load_nr_ulsch_decoding_interface(gNB->nr_ulsch_decoding_interface_version, &nr_ulsch_decoding_interface);
-  }else{
+  } // loading the LDPC library is still necessary for encoding
+
   load_LDPClib(NULL, &ldpc_interface);
 
   if (gNB->ldpc_offload_flag)
     load_LDPClib("_t2", &ldpc_interface_offload);
-  }
   gNB->max_nb_pdsch = MAX_MOBILES_PER_GNB;
   init_delay_table(fp->ofdm_symbol_size, MAX_DELAY_COMP, NR_MAX_OFDM_SYMBOL_SIZE, fp->delay_table);
 

openair1/SIMULATION/NR_PHY/ulsim.c

@@ -496,6 +496,7 @@ int main(int argc, char *argv[])
       printf("-g Channel model configuration. Arguments list: Number of arguments = 3, {Channel model: [A] TDLA30, [B] TDLB100, [C] TDLC300}, {Correlation: [l] Low, [m] Medium, [h] High}, {Maximum Doppler shift} e.g. -g A,l,10\n");
       printf("-h This message\n");
       printf("-i Change channel estimation technique. Arguments list: Number of arguments=2, Frequency domain {0:Linear interpolation, 1:PRB based averaging}, Time domain {0:Estimates of last DMRS symbol, 1:Average of DMRS symbols}. e.g. -i 1,0\n");
+      printf("-j <library_suffix> enable slot decoding module, pass module name suffix as argument, e.g. module name should be \"libnr_ulsch_decoding<library_suffix>.so\"\n");
       printf("-k 3/4 sampling\n");
       printf("-m MCS value\n");
       printf("-n Number of trials to simulate\n");