Add O-RAN 7.2 FHI library

- Add the O-RAN 7.2 FHI library, interfacing with OSC xRAN library (E
  release)
- Add Findxran.cmake to detect the library and headers, including
  version information
- Test for numa and DPDK presence
- Add patch for OSC xRAN to make interworking possible
- Add sample config files for LiteOn, Benetel, and VVDN units.

Documentation is provided in the next commit.
Co-authored-by: Raymond Knopp <raymond.knopp@eurecom.fr>
Co-authored-by: Cedric Roux <cedric.roux@eurecom.fr>
Co-authored-by: Manish Kumar Singh <manish1.kumar@amd.com>
Co-authored-by: thamizhselvan.k <thamizhselvan.k@vvdntech.in>
Co-authored-by: rajeshwari.p <rajeshwari.p@vvdntech.in>
Co-authored-by: Hongzhi Wang <hongzhi.wang@openairinterface.org>
Co-authored-by: Sofia Pison <Sofia.Pison@eurecom.fr>

cmake_targets/build_oai

@@ -96,7 +96,7 @@ Options:
    USRP, BLADERF, LMSSDR, IRIS, SIMU, AW2SORI, None (Default)
    Adds this RF board support (in external packages installation and in compilation)
 -t | --transport
-   Selects the transport protocol type, options: None, Ethernet, benetel4g, benetel5g
+   Selects the transport protocol type, options: None, Ethernet, benetel4g, benetel5g, oran_fhlib_5g
 -P | --phy_simulators
    Makes the unitary tests Layer 1 simulators
 -S | --core_simulators
@@ -302,10 +302,14 @@ function main() {
                 TARGET_LIST="$TARGET_LIST oai_eth_transpro"
                 CMAKE_CMD="$CMAKE_CMD -DOAI_${2^^}=ON" # ^^ makes uppercase
                 ;;
-              "benetel4g" | "benetel5g")
+              "benetel4g" | "benetel5g" | "oran_fhlib_4g")
                 TARGET_LIST="$TARGET_LIST $2"
                 CMAKE_CMD="$CMAKE_CMD -DOAI_${2^^}=ON" # ^^ makes uppercase
                 ;;
+              "oran_fhlib_5g")
+                TARGET_LIST="$TARGET_LIST $2"
+                CMAKE_CMD="$CMAKE_CMD -DOAI_FHI72=ON"
+                ;;
               "None")
                 ;;
               *)
@@ -503,6 +507,12 @@ function main() {
 	echo_info "Built Doxygen based documentation. The documentation file is located here: $OPENAIR_DIR/$BUILD_DIR/build/html/index.html"
     fi
 
+    # TODO: once we got the CMakeLists.txt file done for the ORAN files, remove the following lines
+    if [[ $TARGET_LIST =~ "oran_fhlib_5g" ]]; then
+      rm -f liboai_transpro.so
+      ln -s liboran_fhlib_5g.so liboai_transpro.so
+    fi
+
     if [ "$UE" = 1 ] ; then
 
       echo_info "Compiling UE specific part"

cmake_targets/tools/MODULES/Findxran.cmake

+#
+# 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
+# 
+
+# FindXran
+# -------
+# 
+# Finds the xran library. Note that the library number is as follows:
+# - oran_bronze_release_v1.1 -> 2.1.1 (B = second letter)
+# - oran_e_maintenance_release_v1.0 -> 5.1.0
+# the version is currently hardcoded to 5.1.0
+#
+# Required options
+# ^^^^^^^^^^^^^^^^
+#
+# ``xran_LOCATION``
+#   The location of the library.
+# 
+# Imported Targets
+# ^^^^^^^^^^^^^^^^
+# 
+# This module provides the following imported targets, if found:
+# 
+# ``xran::xran``
+#   The xran library
+# 
+# Result Variables
+# ^^^^^^^^^^^^^^^^
+# 
+# This will define the following variables:
+# 
+# ``xran_FOUND``
+#   True if the system has the xran library.
+# ``xran_VERSION``
+#   The version of the xran library which was found.
+# ``xran_INCLUDE_DIRS``
+#   Include directories needed to use xran.
+# ``xran_LIBRARIES``
+#   Libraries needed to link to xran.
+# 
+# Cache Variables
+# ^^^^^^^^^^^^^^^
+# 
+# The following cache variables may also be set:
+# 
+# ``xran_INCLUDE_DIR``
+#   The directory containing ``foo.h``.
+# ``xran_LIBRARY``
+#   The path to the xran library.
+
+option(xran_LOCATION "directory of XRAN library" "")
+if (NOT xran_LOCATION)
+  message(FATAL_ERROR "xran_LOCATION required")
+endif()
+if (NOT EXISTS ${xran_LOCATION})
+  message(FATAL_ERROR "no such directory: ${xran_LOCATION}")
+endif()
+
+find_path(xran_INCLUDE_DIR
+  NAMES
+    xran_common.h
+    xran_compression.h
+    xran_cp_api.h
+    xran_ecpri_owd_measurements.h
+    xran_fh_o_du.h
+    xran_pkt.h
+    xran_pkt_up.h
+    xran_sync_api.h
+  PATHS ${xran_LOCATION}
+  PATH_SUFFIXES api
+)
+find_library(xran_LIBRARY
+  NAMES xran
+  PATHS ${xran_LOCATION}/build
+)
+if (NOT xran_LIBRARY)
+  message(FATAL_ERROR "could not detect xran build artifacts at ${xran_LOCATION}/build")
+endif()
+
+set(xran_VERSION_FILE "${xran_LOCATION}/../app/src/common.h")
+if(NOT EXISTS ${xran_VERSION_FILE})
+  message(FATAL_ERROR "could not find xran version file at ${xran_VERSION_FILE}")
+endif()
+
+file(STRINGS ${xran_VERSION_FILE} xran_VERSION_LINE REGEX "^#define[ \t]+VERSIONX[ \t]+\"[a-z_.0-9]+\"$")
+string(REGEX REPLACE "^#define[ \t]+VERSIONX[ \t]+\"([a-z_.0-9]+)\"$" "\\1" xran_VERSION_STRING "${xran_VERSION_LINE}")
+message(STATUS "Found xran release ${xran_VERSION_STRING}")
+set(xran_VERSION "NOTFOUND")
+if (xran_VERSION_STRING STREQUAL "oran_e_maintenance_release_v1.0")
+  set(xran_VERSION 5.1.0)
+elseif (xran_VERSION_STRING STREQUAL "oran_e_maintenance_release_v1.1")
+  set(xran_VERSION 5.1.1)
+endif()
+unset(xran_VERSION_LINE)
+unset(xran_VERSION_STRING)
+unset(xran_VERSION_FILE)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(xran
+  FOUND_VAR xran_FOUND
+  REQUIRED_VARS
+    xran_LIBRARY
+    xran_INCLUDE_DIR
+  VERSION_VAR xran_VERSION
+)
+
+if(xran_FOUND)
+  set(xran_LIBRARIES ${xran_LIBRARY})
+  set(xran_INCLUDE_DIRS ${xran_INCLUDE_DIR})
+endif()
+
+if(xran_FOUND AND NOT TARGET xran::xran)
+  add_library(xran::xran UNKNOWN IMPORTED)
+  set_target_properties(xran::xran PROPERTIES
+    IMPORTED_LOCATION "${xran_LIBRARY}"
+    INTERFACE_INCLUDE_DIRECTORIES "${xran_INCLUDE_DIR}"
+  )
+endif()
+
+mark_as_advanced(
+  xran_INCLUDE_DIR
+  xran_LIBRARY
+)

radio/CMakeLists.txt

@@ -13,6 +13,11 @@ if(OAI_BLADERF)
   add_subdirectory(BLADERF)
 endif()
 
+add_boolean_option(OAI_FHI72 OFF "Activate OAI's FHI 7.2 (xran/fhi_lib) driver" OFF)
+if(OAI_FHI72)
+  add_subdirectory(fhi_72)
+endif()
+
 add_boolean_option(OAI_IRIS OFF "Activate OAI's IRIS/SoapySDR driver" OFF)
 if(OAI_IRIS)
   add_subdirectory(IRIS)

radio/fhi_72/CMakeLists.txt

+# use env var PKG_CONFIG_PATH to override paths to libdpdk.pc
+pkg_check_modules(dpdk REQUIRED libdpdk)
+pkg_check_modules(numa REQUIRED numa)
+
+find_package(xran 5.1.1 EXACT REQUIRED) # E release -> 5
+
+# Ignore xran-specific warning: we don't care/can't change the following warning, so suppress
+# alignment 1 of 'struct XYZ' is less than 2
+add_compile_options(-Wno-packed-not-aligned)
+
+add_library(oran_fhlib_5g MODULE
+            oran_isolate.c
+            oaioran.c
+            oran-config.c
+            oran-init.c
+)
+
+set_target_properties(oran_fhlib_5g PROPERTIES COMPILE_FLAGS "-fvisibility=hidden -march=native")
+target_link_libraries(oran_fhlib_5g PRIVATE xran::xran)
+target_link_libraries(oran_fhlib_5g PRIVATE ${dpdk_LINK_LIBRARIES})
+target_include_directories(oran_fhlib_5g PRIVATE ${dpdk_INCLUDE_DIRS})
+target_link_libraries(oran_fhlib_5g PRIVATE pthread dl rt m numa)
+target_link_libraries(oran_fhlib_5g PRIVATE ${T_LIB})
+
+# TODO: can be removed?
+target_include_directories(oran_fhlib_5g PRIVATE ${xran_INCLUDE_DIRS}/../src/)
+
+set_target_properties(oran_fhlib_5g PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
+add_custom_command(TARGET oran_fhlib_5g POST_BUILD
+                   COMMAND ${CMAKE_COMMAND} -E create_symlink liboran_fhlib_5g.so liboai_transpro.so
+                   WORKING_DIRECTORY ${CMAKE_BINARY_DIR})

radio/fhi_72/oaioran.h

+/*
+ * 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
+ */
+
+#ifndef OAIORAN_H
+#define OAIORAN_H
+
+#include <stdint.h>
+#include "xran_fh_o_du.h"
+
+typedef struct {
+  uint32_t tti;
+  uint32_t sl;
+  uint32_t f;
+} oran_sync_info_t;
+
+void oai_xran_fh_rx_callback(void *pCallbackTag, xran_status_t status);
+int oai_physide_dl_tti_call_back(void *param);
+
+#endif /* OAIORAN_H */

radio/fhi_72/oran-config.h

+/*
+ * 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
+ */
+
+#ifndef ORAN_CONFIG_H
+#define ORAN_CONFIG_H
+
+#include "stdbool.h"
+#include "stdint.h"
+
+struct xran_fh_init;
+void print_fh_init(const struct xran_fh_init *fh_init);
+struct xran_fh_config;
+void print_fh_config(const struct xran_fh_config *fh_config);
+
+bool set_fh_init(struct xran_fh_init *fh_init);
+struct openair0_config;
+bool set_fh_config(int ru_idx, int num_rus, const struct openair0_config *oai0_cfg, struct xran_fh_config *fh_config);
+
+// hack to workaround LiteOn limitation
+extern int g_kbar;
+
+#endif /* ORAN_CONFIG_H */

radio/fhi_72/oran-init.h

+/*
+ * 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
+ */
+
+#ifndef ORAN_INIT_H
+#define ORAN_INIT_H
+
+typedef struct oran_bufs {
+  struct xran_flat_buffer tx[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN][XRAN_NUM_OF_SYMBOL_PER_SLOT];
+  struct xran_flat_buffer tx_prbmap[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+  struct xran_flat_buffer rx[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN][XRAN_NUM_OF_SYMBOL_PER_SLOT];
+  struct xran_flat_buffer rx_prbmap[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+
+  struct xran_flat_buffer prach[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN][XRAN_NUM_OF_SYMBOL_PER_SLOT];
+  struct xran_flat_buffer prachdecomp[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN][XRAN_NUM_OF_SYMBOL_PER_SLOT];
+} oran_bufs_t;
+
+typedef struct oran_buf_list {
+  // xran API requires buffer lists as structs of arrays
+  struct xran_buffer_list src[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+  struct xran_buffer_list srccp[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+  struct xran_buffer_list dst[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+  struct xran_buffer_list dstcp[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+
+  struct xran_buffer_list prachdst[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+  struct xran_buffer_list prachdstdecomp[XRAN_MAX_ANTENNA_NR][XRAN_N_FE_BUF_LEN];
+
+  oran_bufs_t bufs;
+} oran_buf_list_t;
+
+typedef struct oran_port_instance_t {
+  oran_buf_list_t *buf_list;
+  void *instanceHandle;
+  //uint32_t dpdkPoolIndex[MAX_SW_XRAN_INTERFACE_NUM];
+
+  struct xran_cb_tag RxCbTag[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
+  struct xran_cb_tag PrachCbTag[XRAN_PORTS_NUM][XRAN_MAX_SECTOR_NR];
+} oran_port_instance_t;
+
+extern struct xran_fh_config gxran_fh_config[XRAN_PORTS_NUM];
+extern void *gxran_handle;
+
+struct openair0_config;
+int *oai_oran_initialize(const struct openair0_config *openair0_cfg);
+
+#endif /* ORAN_INIT_H */

radio/fhi_72/oran-params.h

+/*
+ * 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
+ */
+
+#ifndef ORAN_PARAMS_H
+#define ORAN_PARAMS_H
+
+#include "stdbool.h"
+#include "stdint.h"
+
+#define CONFIG_STRING_ORAN "fhi_72"
+
+#define ORAN_CONFIG_DPDK_DEVICES "dpdk_devices"
+#define ORAN_CONFIG_IO_CORE "io_core"
+#define ORAN_CONFIG_WORKER_CORES "worker_cores"
+#define ORAN_CONFIG_DU_ADDR "du_addr"
+#define ORAN_CONFIG_RU_ADDR "ru_addr"
+#define ORAN_CONFIG_MTU "mtu"
+#define ORAN_CONFIG_FILE_PREFIX "file_prefix"
+#define ORAN_CONFIG_NETHPERPORT "eth_lines"
+#define ORAN_CONFIG_NETHSPEED "eth_speed"
+
+// clang-format off
+// TODO: PCI addr check
+// TODO: ethernet addr check
+#define ORAN_GLOBALPARAMS_DESC { \
+  {ORAN_CONFIG_DPDK_DEVICES,    "PCI addr of devices for DPDK\n",           PARAMFLAG_MANDATORY, .strlistptr=NULL, .defstrlistval=NULL, TYPE_STRINGLIST, 0}, \
+  {ORAN_CONFIG_IO_CORE,         "DPDK Core used for IO\n",                  PARAMFLAG_MANDATORY, .iptr=NULL,       .defintval=4,        TYPE_INT,        0}, \
+  {ORAN_CONFIG_WORKER_CORES,    "CPU Cores to use for workers\n",           PARAMFLAG_MANDATORY, .uptr=NULL,       .defintarrayval=NULL,TYPE_UINTARRAY,  0}, \
+  {ORAN_CONFIG_DU_ADDR,         "Ether addr of DU\n",                       PARAMFLAG_MANDATORY, .strlistptr=NULL, .defstrlistval=NULL, TYPE_STRINGLIST, 0}, \
+  {ORAN_CONFIG_RU_ADDR,         "Ether addr of RU\n",                       PARAMFLAG_MANDATORY, .strlistptr=NULL, .defstrlistval=NULL, TYPE_STRINGLIST, 0}, \
+  {ORAN_CONFIG_MTU,             "MTU of Eth interface\n",                   PARAMFLAG_MANDATORY, .uptr=NULL,       .defuintval=1500,    TYPE_UINT,       0}, \
+  {ORAN_CONFIG_FILE_PREFIX,     "DPDK file-prefix\n",                       0,                   .strptr=NULL,     .defstrval="wls_0",  TYPE_STRING,     0}, \
+  {ORAN_CONFIG_NETHPERPORT,     "number of links per port\n",               0,                   .uptr=NULL,       .defuintval=1,       TYPE_UINT,       0}, \
+  {ORAN_CONFIG_NETHSPEED,       "ethernet speed link\n",                    0,                   .uptr=NULL,       .defuintval=10,      TYPE_UINT,       0}, \
+}
+// clang-format on
+
+#define CONFIG_STRING_ORAN_FH "fh_config"
+
+#define ORAN_FH_CONFIG_TADV_CP_DL "Tadv_cp_dl"
+#define ORAN_FH_CONFIG_T2A_CP_DL "T2a_cp_dl"
+#define ORAN_FH_CONFIG_T2A_CP_UL "T2a_cp_ul"
+#define ORAN_FH_CONFIG_T2A_UP "T2a_up"
+#define ORAN_FH_CONFIG_TA3 "Ta3"
+#define ORAN_FH_CONFIG_T1A_CP_DL "T1a_cp_dl"
+#define ORAN_FH_CONFIG_T1A_CP_UL "T1a_cp_ul"
+#define ORAN_FH_CONFIG_T1A_UP "T1a_up"
+#define ORAN_FH_CONFIG_TA4 "Ta4"
+#define ORAN_FH_CONFIG_CP_VLAN_TAG "cp_vlan_tag"
+#define ORAN_FH_CONFIG_UP_VLAN_TAG "up_vlan_tag"
+
+#define ORAN_FH_HLP_CPLT " parameter of RU in list form (Min&Max, length 2!)\n"
+
+// clang-format off
+#define ORAN_FH_DESC { \
+  {ORAN_FH_CONFIG_TADV_CP_DL,   "Tadv parameter of RU\n",      PARAMFLAG_MANDATORY, .uptr=NULL, .defuintval=0,     TYPE_UINT,      0}, \
+  {ORAN_FH_CONFIG_T2A_CP_DL,    "T2a_cp_dl" ORAN_FH_HLP_CPLT,  PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_T2A_CP_UL,    "T2a_cp_ul" ORAN_FH_HLP_CPLT,  PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_T2A_UP,       "T2a_up" ORAN_FH_HLP_CPLT,     PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_TA3,          "Ta3" ORAN_FH_HLP_CPLT,        PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_T1A_CP_DL,    "T1a_cp_dl" ORAN_FH_HLP_CPLT,  PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_T1A_CP_UL,    "T1a_cp_ul" ORAN_FH_HLP_CPLT,  PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_T1A_UP,       "T1a_up" ORAN_FH_HLP_CPLT,     PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_TA4,          "Ta4" ORAN_FH_HLP_CPLT,        PARAMFLAG_MANDATORY, .uptr=NULL, .defintarrayval=0, TYPE_UINTARRAY, 0}, \
+  {ORAN_FH_CONFIG_CP_VLAN_TAG,  "not used by xran",            0,                   .uptr=NULL, .defuintval=0,     TYPE_UINT,      0}, \
+  {ORAN_FH_CONFIG_UP_VLAN_TAG,  "not used by xran",            0,                   .uptr=NULL, .defuintval=0,     TYPE_UINT,      0}, \
+}
+// clang-format on
+
+#define CONFIG_STRING_ORAN_RU "ru_config"
+
+#define ORAN_RU_CONFIG_IQWIDTH "iq_width"
+#define ORAN_RU_CONFIG_IQWIDTH_PRACH "iq_width_prach"
+#define ORAN_RU_CONFIG_FFT_SIZE "fft_size"
+
+// clang-format off
+#define ORAN_RU_DESC {\
+  {ORAN_RU_CONFIG_IQWIDTH,       "sample IQ width (16=uncompressed)\n",       PARAMFLAG_MANDATORY, .u8ptr=NULL, .defuintval=16, TYPE_UINT8, 0}, \
+  {ORAN_RU_CONFIG_IQWIDTH_PRACH, "PRACH sample IQ width (16=uncompressed)\n", PARAMFLAG_MANDATORY, .u8ptr=NULL, .defuintval=16, TYPE_UINT8, 0}, \
+  {ORAN_RU_CONFIG_FFT_SIZE,      "Size of FFT at RU\n",                       PARAMFLAG_MANDATORY, .u8ptr=NULL, .defuintval=12, TYPE_UINT8, 0}, \
+}
+// clang-format on
+
+#define CONFIG_STRING_ORAN_PRACH "prach_config"
+
+#define ORAN_PRACH_CONFIG_EAXC_OFFSET "eAxC_offset"
+#define ORAN_PRACH_CONFIG_KBAR "kbar"
+
+// clang-format off
+#define ORAN_PRACH_DESC {\
+  {ORAN_PRACH_CONFIG_EAXC_OFFSET, "RU's eAxC offset for PRACH\n", PARAMFLAG_MANDATORY, .u8ptr=NULL, .defuintval=0, TYPE_UINT8, 0}, \
+  {ORAN_PRACH_CONFIG_KBAR,        "PRACH guard interval\n",       0,                   .uptr=NULL,  .defuintval=4, TYPE_UINT,  0}, \
+}
+// clang-format on
+
+#endif /* ORAN_PARAMS_H */

radio/fhi_72/oran.h

+/*
+ * 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
+ */
+
+#ifndef _ORAN_H_
+#define _ORAN_H_
+
+#include "shared_buffers.h"
+#include "common_lib.h"
+void oran_fh_if4p5_south_out(RU_t *ru, int frame, int slot, uint64_t timestamp);
+
+void oran_fh_if4p5_south_in(RU_t *ru, int *frame, int *slot);
+
+int transport_init(openair0_device *device, openair0_config_t *openair0_cfg, eth_params_t *eth_params);
+
+typedef struct {
+  eth_state_t e;
+  shared_buffers buffers;
+  rru_config_msg_type_t last_msg;
+  int capabilities_sent;
+  void *oran_priv;
+} oran_eth_state_t;
+#endif /* _ORAN_H_ */

radio/fhi_72/oran_isolate.c

+/*
+ * 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
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include "common_lib.h"
+#include "radio/ETHERNET/ethernet_lib.h"
+#include "oran_isolate.h"
+#include "oran-init.h"
+#include "xran_fh_o_du.h"
+#include "xran_sync_api.h"
+
+#include "common/utils/LOG/log.h"
+#include "common/utils/LOG/vcd_signal_dumper.h"
+#include "openair1/PHY/defs_gNB.h"
+#include "common/utils/threadPool/thread-pool.h"
+#include "oaioran.h"
+
+typedef struct {
+  eth_state_t e;
+  rru_config_msg_type_t last_msg;
+  int capabilities_sent;
+  void *oran_priv;
+} oran_eth_state_t;
+
+notifiedFIFO_t oran_sync_fifo;
+
+int trx_oran_start(openair0_device *device)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+
+  oran_eth_state_t *s = device->priv;
+
+  // Start ORAN
+  if (xran_start(s->oran_priv) != 0) {
+    printf("%s:%d:%s: Start ORAN failed ... Exit\n", __FILE__, __LINE__, __FUNCTION__);
+    exit(1);
+  } else {
+    printf("Start ORAN. Done\n");
+  }
+  return 0;
+}
+
+void trx_oran_end(openair0_device *device)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  oran_eth_state_t *s = device->priv;
+  xran_close(s->oran_priv);
+}
+
+int trx_oran_stop(openair0_device *device)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  oran_eth_state_t *s = device->priv;
+  xran_stop(s->oran_priv);
+  return (0);
+}
+
+int trx_oran_set_freq(openair0_device *device, openair0_config_t *openair0_cfg)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return (0);
+}
+
+int trx_oran_set_gains(openair0_device *device, openair0_config_t *openair0_cfg)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return (0);
+}
+
+int trx_oran_get_stats(openair0_device *device)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return (0);
+}
+
+int trx_oran_reset_stats(openair0_device *device)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return (0);
+}
+
+int ethernet_tune(openair0_device *device, unsigned int option, int value)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return 0;
+}
+
+int trx_oran_write_raw(openair0_device *device, openair0_timestamp timestamp, void **buff, int nsamps, int cc, int flags)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return 0;
+}
+
+int trx_oran_read_raw(openair0_device *device, openair0_timestamp *timestamp, void **buff, int nsamps, int cc)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+  return 0;
+}
+
+char *msg_type(int t)
+{
+  static char *s[12] = {
+      "RAU_tick",
+      "RRU_capabilities",
+      "RRU_config",
+      "RRU_config_ok",
+      "RRU_start",
+      "RRU_stop",
+      "RRU_sync_ok",
+      "RRU_frame_resynch",
+      "RRU_MSG_max_num",
+      "RRU_check_sync",
+      "RRU_config_update",
+      "RRU_config_update_ok",
+  };
+
+  if (t < 0 || t > 11)
+    return "UNKNOWN";
+  return s[t];
+}
+
+int trx_oran_ctlsend(openair0_device *device, void *msg, ssize_t msg_len)
+{
+  RRU_CONFIG_msg_t *rru_config_msg = msg;
+  oran_eth_state_t *s = device->priv;
+
+  printf("ORAN: %s\n", __FUNCTION__);
+
+  printf("    rru_config_msg->type %d [%s]\n", rru_config_msg->type, msg_type(rru_config_msg->type));
+
+  s->last_msg = rru_config_msg->type;
+
+  return msg_len;
+}
+
+int trx_oran_ctlrecv(openair0_device *device, void *msg, ssize_t msg_len)
+{
+  RRU_CONFIG_msg_t *rru_config_msg = msg;
+  oran_eth_state_t *s = device->priv;
+
+  printf("ORAN: %s\n", __FUNCTION__);
+
+  if (s->last_msg == RAU_tick && s->capabilities_sent == 0) {
+    printf("ORAN ctrlrcv RRU_tick received and send capabilities hard coded\n");
+    RRU_capabilities_t *cap;
+    rru_config_msg->type = RRU_capabilities;
+    rru_config_msg->len = sizeof(RRU_CONFIG_msg_t) - MAX_RRU_CONFIG_SIZE + sizeof(RRU_capabilities_t);
+    // Fill RRU capabilities (see openair1/PHY/defs_RU.h)
+    // For now they are hard coded - try to retreive the params from openari device
+
+    cap = (RRU_capabilities_t *)&rru_config_msg->msg[0];
+    cap->FH_fmt = OAI_IF4p5_only;
+    cap->num_bands = 1;
+    cap->band_list[0] = 78;
+    // cap->num_concurrent_bands             = 1; component carriers
+    cap->nb_rx[0] = 1; // device->openair0_cfg->rx_num_channels;
+    cap->nb_tx[0] = 1; // device->openair0_cfg->tx_num_channels;
+    cap->max_pdschReferenceSignalPower[0] = -27;
+    cap->max_rxgain[0] = 90;
+    cap->N_RB_DL[0] = 106;
+    cap->N_RB_UL[0] = 106;
+
+    s->capabilities_sent = 1;
+
+    return rru_config_msg->len;
+  }
+  if (s->last_msg == RRU_config) {
+    printf("Oran RRU_config\n");
+    rru_config_msg->type = RRU_config_ok;
+  }
+  return 0;
+}
+
+void oran_fh_if4p5_south_in(RU_t *ru, int *frame, int *slot)
+{
+  ru_info_t ru_info;
+  ru_info.nb_rx = ru->nb_rx;
+  ru_info.rxdataF = ru->common.rxdataF;
+  ru_info.prach_buf = ru->prach_rxsigF[0]; // index: [prach_oca][ant_id]
+
+  RU_proc_t *proc = &ru->proc;
+  extern uint16_t sl_ahead;
+  int f, sl;
+  LOG_D(PHY, "Read rxdataF %p,%p\n", ru_info.rxdataF[0], ru_info.rxdataF[1]);
+  start_meas(&ru->rx_fhaul);
+  int ret = xran_fh_rx_read_slot(&ru_info, &f, &sl);
+  stop_meas(&ru->rx_fhaul);
+  LOG_D(PHY, "Read %d.%d rxdataF %p,%p\n", f, sl, ru_info.rxdataF[0], ru_info.rxdataF[1]);
+  if (ret != 0) {
+    printf("ORAN: %d.%d ORAN_fh_if4p5_south_in ERROR in RX function \n", f, sl);
+  }
+
+  proc->tti_rx = sl;
+  proc->frame_rx = f;
+  proc->tti_tx = (sl + sl_ahead) % 20;
+  proc->frame_tx = (sl > (19 - sl_ahead)) ? (f + 1) & 1023 : f;
+
+  if (proc->first_rx == 0) {
+    if (proc->tti_rx != *slot) {
+      LOG_E(PHY,
+            "Received Time doesn't correspond to the time we think it is (slot mismatch, received %d.%d, expected %d.%d)\n",
+            proc->frame_rx,
+            proc->tti_rx,
+            *frame,
+            *slot);
+      *slot = proc->tti_rx;
+    }
+
+    if (proc->frame_rx != *frame) {
+      LOG_E(PHY,
+            "Received Time doesn't correspond to the time we think it is (frame mismatch, %d.%d , expected %d.%d)\n",
+            proc->frame_rx,
+            proc->tti_rx,
+            *frame,
+            *slot);
+      *frame = proc->frame_rx;
+    }
+  } else {
+    proc->first_rx = 0;
+    LOG_I(PHY, "before adjusting, OAI: frame=%d slot=%d, XRAN: frame=%d slot=%d\n", *frame, *slot, proc->frame_rx, proc->tti_rx);
+    *frame = proc->frame_rx;
+    *slot = proc->tti_rx;
+    LOG_I(PHY, "After adjusting, OAI: frame=%d slot=%d, XRAN: frame=%d slot=%d\n", *frame, *slot, proc->frame_rx, proc->tti_rx);
+  }
+}
+
+void oran_fh_if4p5_south_out(RU_t *ru, int frame, int slot, uint64_t timestamp)
+{
+  start_meas(&ru->tx_fhaul);
+  ru_info_t ru_info;
+  ru_info.nb_tx = ru->nb_tx;
+  ru_info.txdataF_BF = ru->common.txdataF_BF;
+  // printf("south_out:\tframe=%d\tslot=%d\ttimestamp=%ld\n",frame,slot,timestamp);
+
+  int ret = xran_fh_tx_send_slot(&ru_info, frame, slot, timestamp);
+  if (ret != 0) {
+    printf("ORAN: ORAN_fh_if4p5_south_out ERROR in TX function \n");
+  }
+  stop_meas(&ru->tx_fhaul);
+}
+
+void *get_internal_parameter(char *name)
+{
+  printf("ORAN: %s\n", __FUNCTION__);
+
+  if (!strcmp(name, "fh_if4p5_south_in"))
+    return (void *)oran_fh_if4p5_south_in;
+  if (!strcmp(name, "fh_if4p5_south_out"))
+    return (void *)oran_fh_if4p5_south_out;
+
+  return NULL;
+}
+
+__attribute__((__visibility__("default"))) int transport_init(openair0_device *device,
+                                                              openair0_config_t *openair0_cfg,
+                                                              eth_params_t *eth_params)
+{
+  oran_eth_state_t *eth;
+
+  device->Mod_id = 0;
+  device->transp_type = ETHERNET_TP;
+  device->trx_start_func = trx_oran_start;
+  device->trx_get_stats_func = trx_oran_get_stats;
+  device->trx_reset_stats_func = trx_oran_reset_stats;
+  device->trx_end_func = trx_oran_end;
+  device->trx_stop_func = trx_oran_stop;
+  device->trx_set_freq_func = trx_oran_set_freq;
+  device->trx_set_gains_func = trx_oran_set_gains;
+
+  device->trx_write_func = trx_oran_write_raw;
+  device->trx_read_func = trx_oran_read_raw;
+
+  device->trx_ctlsend_func = trx_oran_ctlsend;
+  device->trx_ctlrecv_func = trx_oran_ctlrecv;
+
+  device->get_internal_parameter = get_internal_parameter;
+
+  eth = (oran_eth_state_t *)calloc(1, sizeof(oran_eth_state_t));
+  if (eth == NULL) {
+    AssertFatal(0 == 1, "out of memory\n");
+  }
+
+  eth->e.flags = ETH_RAW_IF4p5_MODE;
+  eth->e.compression = NO_COMPRESS;
+  eth->e.if_name = eth_params->local_if_name;
+  eth->oran_priv = NULL; // define_oran_pointer();
+  device->priv = eth;
+  device->openair0_cfg = &openair0_cfg[0];
+
+  eth->last_msg = (rru_config_msg_type_t)-1;
+
+  printf("ORAN: %s\n", __FUNCTION__);
+
+  initNotifiedFIFO(&oran_sync_fifo);
+  eth->oran_priv = oai_oran_initialize(openair0_cfg);
+  AssertFatal(eth->oran_priv != NULL, "can not initialize fronthaul");
+  // create message queues for ORAN sync
+  return 0;
+}

radio/fhi_72/oran_isolate.h

+/*
+ * 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
+ */
+
+#ifndef _ORAN_ISOLATE_H_
+#define _ORAN_ISOLATE_H_
+
+#include <stdio.h>
+
+#include <pthread.h>
+#include <stdint.h>
+
+#include "xran_fh_o_du.h"
+
+/*
+ * Structure added to bear the information needed from OAI RU
+ */
+typedef struct ru_info_s {
+  // Needed for UL
+  int nb_rx;
+  int32_t **rxdataF;
+
+  // Needed for DL
+  int nb_tx;
+  int32_t **txdataF_BF;
+
+  // Needed for Prach
+  int16_t **prach_buf;
+} ru_info_t;
+
+int xran_fh_rx_read_slot(ru_info_t *ru, int *frame, int *slot);
+int xran_fh_tx_send_slot(ru_info_t *ru, int frame, int slot, uint64_t timestamp);
+
+int compute_xran_statistics();
+
+#endif /* _ORAN_ISOLATE_H_ */