diff --git a/CMakeLists.txt b/CMakeLists.txt index e6147ce3fb..d9a226aed4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -849,6 +849,10 @@ set(PHY_NR_CODINGIF ${OPENAIR1_DIR}/PHY/CODING/nrLDPC_load.c ) +set(PHY_NRLDPC_CODINGIF + ${OPENAIR1_DIR}/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface_load.c +) + ############################################## # Base CUDA setting ############################################## @@ -1058,6 +1062,7 @@ set(PHY_SRC_UE ${PHY_POLARSRC} ${PHY_SMALLBLOCKSRC} ${PHY_NR_CODINGIF} + ${PHY_NRLDPC_CODINGIF} ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/pucch_rx.c ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/srs_rx.c ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/nr_uci_tools_common.c @@ -1113,6 +1118,7 @@ set(PHY_SRC_UE ${PHY_POLARSRC} ${PHY_SMALLBLOCKSRC} ${PHY_NR_CODINGIF} + ${PHY_NRLDPC_CODINGIF} ) diff --git a/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface.h b/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface.h new file mode 100644 index 0000000000..6492131df3 --- /dev/null +++ b/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface.h @@ -0,0 +1,261 @@ +/* + * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The OpenAirInterface Software Alliance licenses this file to You under + * the OAI Public License, Version 1.1 (the "License"); you may not use this file + * except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.openairinterface.org/?page_id=698 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + *------------------------------------------------------------------------------- + * For more information about the OpenAirInterface (OAI) Software Alliance: + * contact@openairinterface.org + */ + +/*! \file openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface.h + * \brief interface for libraries implementing coding/decoding algorithms + */ + +#include "PHY/defs_gNB.h" + +#ifndef __NRLDPC_CODING_INTERFACE__H__ +#define __NRLDPC_CODING_INTERFACE__H__ + +/** + * \typedef nrLDPC_segment_decoding_parameters_t + * \struct nrLDPC_segment_decoding_parameters_s + * \brief decoding parameter of segments + * \var E input llr segment size + * \var R code rate indication + * \var llr segment input llr array + * \var d Pointers to code blocks before LDPC decoding (38.212 V15.4.0 section 5.3.2) + * \var d_to_be_cleared + * pointer to the flag used to clear d properly + * when true, clear d after rate dematching + * \var c Pointers to code blocks after LDPC decoding (38.212 V15.4.0 section 5.2.2) + * \var decodeSuccess + * flag indicating that the decoding of the segment was successful + * IT MUST BE FILLED BY THE IMPLEMENTATION + * \var ts_deinterleave deinterleaving time stats + * \var ts_rate_unmatch rate unmatching time stats + * \var ts_ldpc_decode decoding time stats + */ +typedef struct nrLDPC_segment_decoding_parameters_s{ + int E; + uint8_t R; + short *llr; + int16_t *d; + bool *d_to_be_cleared; + uint8_t *c; + bool decodeSuccess; + time_stats_t ts_deinterleave; + time_stats_t ts_rate_unmatch; + time_stats_t ts_ldpc_decode; +} nrLDPC_segment_decoding_parameters_t; + +/** + * \typedef nrLDPC_TB_decoding_parameters_t + * \struct nrLDPC_TB_decoding_parameters_s + * \brief decoding parameter of transport blocks + * \var harq_unique_pid unique id of the HARQ process + * WARNING This id should be unique in the whole instance + * among the active HARQ processes for the duration of the process + * \var processedSegments + * pointer to the number of succesfully decoded segments + * it initially holds the total number of segments decoded after the previous HARQ round + * it finally holds the total number of segments decoded after the current HARQ round + * \var nb_rb number of resource blocks + * \var Qm modulation order + * \var mcs MCS + * \var nb_layers number of layers + * \var BG LDPC base graph id + * \var rv_index redundancy version of the current HARQ round + * \var max_ldpc_iterations maximum number of LDPC iterations + * \var abort_decode pointer to decode abort flag + * \var G Available radio resource bits + * \var tbslbrm Transport block size LBRM + * \var A Transport block size (This is A from 38.212 V15.4.0 section 5.1) + * \var K Code block size at decoder output + * \var Z lifting size + * \var F filler bits size + * \var C number of segments + * \var segments array of segments parameters + */ +typedef struct nrLDPC_TB_decoding_parameters_s{ + + uint32_t harq_unique_pid; + uint32_t *processedSegments; + + uint16_t nb_rb; + uint8_t Qm; + uint8_t mcs; + uint8_t nb_layers; + + uint8_t BG; + uint8_t rv_index; + uint8_t max_ldpc_iterations; + decode_abort_t *abort_decode; + + uint32_t G; + uint32_t tbslbrm; + uint32_t A; + uint32_t K; + uint32_t Z; + uint32_t F; + + uint32_t C; + nrLDPC_segment_decoding_parameters_t *segments; +} nrLDPC_TB_decoding_parameters_t; + +/** + * \typedef nrLDPC_slot_decoding_parameters_t + * \struct nrLDPC_slot_decoding_parameters_s + * \brief decoding parameter of slot + * \var frame frame index + * \var slot slot index + * \var nb_TBs number of transport blocks + * \var threadPool pointer to the thread pool + * The thread pool can be used by the implementation + * in order to launch jobs internally + * DEQUEUING THE JOBS IS DONE WITHIN THE IMPLEMENTATION + * \var TBs array of TBs decoding parameters + */ +typedef struct nrLDPC_slot_decoding_parameters_s{ + int frame; + int slot; + int nb_TBs; + tpool_t *threadPool; + nrLDPC_TB_decoding_parameters_t *TBs; +} nrLDPC_slot_decoding_parameters_t; + +/** + * \typedef nrLDPC_segment_encoding_parameters_t + * \struct nrLDPC_segment_encoding_parameters_s + * \brief encoding parameter of segments + * \var E input llr segment size + * \var output input llr segment array + * \var c Pointers to code blocks before LDPC encoding (38.212 V15.4.0 section 5.2.2) + * flag indicating that the decoding of the segment was successful + * IT MUST BE FILLED BY THE IMPLEMENTATION + * \var ts_interleave interleaving time stats + * \var ts_rate_match rate matching time stats + * \var ts_ldpc_encode encoding time stats + */ +typedef struct nrLDPC_segment_encoding_parameters_s{ + int E; + unsigned char *output; + uint8_t *c; + time_stats_t ts_interleave; + time_stats_t ts_rate_match; + time_stats_t ts_ldpc_encode; +} nrLDPC_segment_encoding_parameters_t; + +/** + * \typedef nrLDPC_TB_encoding_parameters_t + * \struct nrLDPC_TB_encoding_parameters_s + * \brief encoding parameter of transport blocks + * \var harq_unique_pid unique id of the HARQ process + * WARNING This id should be unique in the whole instance + * among the active HARQ processes for the duration of the process + * \var nb_rb number of resource blocks + * \var Qm modulation order + * \var mcs MCS + * \var nb_layers number of layers + * \var BG LDPC base graph id + * \var rv_index + * \var G Available radio resource bits + * \var tbslbrm Transport block size LBRM + * \var A Transport block size (This is A from 38.212 V15.4.0 section 5.1) + * \var Kb Code block size divided by lifting size + * \var K Code block size at input of encoder + * \var Z lifting size + * \var F filler bits size + * \var C number of segments + * \var segments array of segments parameters + */ +typedef struct nrLDPC_TB_encoding_parameters_s{ + + uint32_t harq_unique_pid; + + uint16_t nb_rb; + uint8_t Qm; + uint8_t mcs; + uint8_t nb_layers; + + uint8_t BG; + uint8_t rv_index; + + uint32_t G; + uint32_t tbslbrm; + uint32_t A; + uint32_t Kb; + uint32_t K; + uint32_t Z; + uint32_t F; + + uint32_t C; + nrLDPC_segment_encoding_parameters_t *segments; +} nrLDPC_TB_encoding_parameters_t; + +/** + * \typedef nrLDPC_slot_encoding_parameters_t + * \struct nrLDPC_slot_encoding_parameters_s + * \brief encoding parameter of slot + * \var frame frame index + * \var slot slot index + * \var nb_TBs number of transport blocks + * \var threadPool pointer to the thread pool + * The thread pool can be used by the implementation + * in order to launch jobs internally + * DEQUEUING THE JOBS IS DONE WITHIN THE IMPLEMENTATION + * \var tinput pointer to the input timer struct + * \var tprep pointer to the preparation timer struct + * \var tparity pointer to the parity timer struct + * \var toutput pointer to the output timer struct + * \var TBs array of TBs decoding parameters + */ +typedef struct nrLDPC_slot_encoding_parameters_s{ + int frame; + int slot; + int nb_TBs; + tpool_t *threadPool; + time_stats_t *tinput; + time_stats_t *tprep; + time_stats_t *tparity; + time_stats_t *toutput; + nrLDPC_TB_encoding_parameters_t *TBs; +} nrLDPC_slot_encoding_parameters_t; + +typedef int32_t(nrLDPC_coding_init_t)(void); +typedef int32_t(nrLDPC_coding_shutdown_t)(void); + +/** + * \brief slot decoding function interface + * \param nrLDPC_slot_decoding_parameters pointer to the structure holding the parameters necessary for decoding + */ +typedef int32_t(nrLDPC_coding_decoder_t)(nrLDPC_slot_decoding_parameters_t *nrLDPC_slot_decoding_parameters); + +/** + * \brief slot encoding function interface + * \param nrLDPC_slot_encoding_parameters pointer to the structure holding the parameters necessary for encoding + */ +typedef int32_t(nrLDPC_coding_encoder_t)(nrLDPC_slot_encoding_parameters_t *nrLDPC_slot_encoding_parameters); + +typedef struct nrLDPC_coding_interface_s { + nrLDPC_coding_init_t *nrLDPC_coding_init; + nrLDPC_coding_shutdown_t *nrLDPC_coding_shutdown; + nrLDPC_coding_decoder_t *nrLDPC_coding_decoder; + nrLDPC_coding_encoder_t *nrLDPC_coding_encoder; +} nrLDPC_coding_interface_t; + +int load_nrLDPC_coding_interface(char *version, nrLDPC_coding_interface_t *interface); +int free_nrLDPC_coding_interface(nrLDPC_coding_interface_t *interface); + +#endif diff --git a/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface_load.c b/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface_load.c new file mode 100644 index 0000000000..4819b68598 --- /dev/null +++ b/openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface_load.c @@ -0,0 +1,74 @@ +/* + * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The OpenAirInterface Software Alliance licenses this file to You under + * the OAI Public License, Version 1.1 (the "License"); you may not use this file + * except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.openairinterface.org/?page_id=698 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + *------------------------------------------------------------------------------- + * For more information about the OpenAirInterface (OAI) Software Alliance: + * contact@openairinterface.org + */ + +/*! \file openair1/PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface_load.c + * \brief load library implementing coding/decoding algorithms + */ + +#define _GNU_SOURCE +#include +#include +#include +#include "assertions.h" +#include "common/utils/LOG/log.h" +#include "PHY/CODING/nrLDPC_coding/nrLDPC_coding_interface.h" +#include "PHY/CODING/nrLDPC_extern.h" +#include "common/config/config_userapi.h" +#include "common/utils/load_module_shlib.h" + +/* arguments used when called from phy simulators exec's which do not use the config module */ +/* arg is used to initialize the config module so that the loader works as expected */ +char *arguments_phy_simulators[64]={"ldpctest",NULL}; + +int load_nrLDPC_coding_interface(char *version, nrLDPC_coding_interface_t *itf) +{ + char *ptr = (char *)config_get_if(); + char libname[64] = "ldpc"; + + if (ptr == NULL) { // phy simulators, config module possibly not loaded + uniqCfg = load_configmodule(1, arguments_phy_simulators, CONFIG_ENABLECMDLINEONLY); + logInit(); + } + /* function description array, to be used when loading the encoding/decoding shared lib */ + loader_shlibfunc_t shlib_fdesc[] = {{.fname = "nrLDPC_coding_init"}, + {.fname = "nrLDPC_coding_shutdown"}, + {.fname = "nrLDPC_coding_decoder"}, + {.fname = "nrLDPC_coding_encoder"}}; + int ret; + ret = load_module_version_shlib(libname, version, shlib_fdesc, sizeofArray(shlib_fdesc), NULL); + if(ret < 0){ + LOG_D(PHY, "NR ULSCH decoding module unavailable"); + return ret; + } + itf->nrLDPC_coding_init = (nrLDPC_coding_init_t *)shlib_fdesc[0].fptr; + itf->nrLDPC_coding_shutdown = (nrLDPC_coding_shutdown_t *)shlib_fdesc[1].fptr; + itf->nrLDPC_coding_decoder = (nrLDPC_coding_decoder_t *)shlib_fdesc[2].fptr; + itf->nrLDPC_coding_encoder = (nrLDPC_coding_encoder_t *)shlib_fdesc[3].fptr; + + AssertFatal(itf->nrLDPC_coding_init() == 0, "error starting LDPC library %s %s\n", libname, version); + + return 0; +} + +int free_nrLDPC_coding_interface(nrLDPC_coding_interface_t *interface) +{ + return interface->nrLDPC_coding_shutdown(); +}