Merge remote-tracking branch 'origin/ci-rfsim-add-channel' into integration_2024_w15

2024-04-15 08:47:01 +02:00
parent de263d4a40 5b0e797ef7
commit eb487e0196
14 changed files with 252 additions and 17 deletions
@@ -59,6 +59,11 @@ add_library(telnetsrv_ci MODULE telnetsrv_ci.c)
 target_link_libraries(telnetsrv_ci PRIVATE asn1_nr_rrc_hdrs asn1_lte_rrc_hdrs)
 add_dependencies(telnetsrv telnetsrv_ci)

+message(STATUS "Add CI specific telnet functions for nrUE in telnetsrv_ciUE.so")
+add_library(telnetsrv_ciUE MODULE telnetsrv_ciUE.c)
+target_link_libraries(telnetsrv_ciUE PRIVATE asn1_nr_rrc_hdrs asn1_lte_rrc_hdrs)
+add_dependencies(telnetsrv telnetsrv_ciUE)
+
 message(STATUS "Add bearer specific telnet functions in libtelnetsrv_bearer.so")
 add_library(telnetsrv_bearer MODULE telnetsrv_bearer.c)
 target_link_libraries(telnetsrv_bearer PRIVATE asn1_nr_rrc_hdrs asn1_lte_rrc_hdrs)
@@ -70,7 +75,7 @@ target_link_libraries(telnetsrv_rrc PRIVATE asn1_nr_rrc_hdrs asn1_lte_rrc_hdrs)
 add_dependencies(telnetsrv telnetsrv_rrc)

 # all libraries should be written to root build dir
-set_target_properties(telnetsrv telnetsrv_enb telnetsrv_5Gue telnetsrv_ci telnetsrv_bearer telnetsrv_rrc
+set_target_properties(telnetsrv telnetsrv_enb telnetsrv_5Gue telnetsrv_ci telnetsrv_ciUE telnetsrv_bearer telnetsrv_rrc
                      PROPERTIES LIBRARY_OUTPUT_DIRECTORY ../../..
 )

@@ -8,7 +8,17 @@ By default the embedded telnet server, which is implemented in a shared library,
 ./build_oai  --build-lib telnetsrv
 ```

-This will create the `libtelnetsrv.so` and `libtelnetsrv_<app>` file in the `cmake_targets/ran_build/build` subdirectory of the oai repository. `<app>` can be "enb", "gnb", "4GUE", "5GUE", or "ci", each library containing functions specific to a given executable.
+This will create the `libtelnetsrv.so` and `libtelnetsrv_<app>` file in the `cmake_targets/ran_build/build` subdirectory of the oai repository. `<app>` can be "enb", "gnb", "4GUE", "5GUE", "ci" or "ciUE" each library containing functions specific to a given executable:
+
+| **Library Name**          | **Description**                     |
+|---------------------------|-------------------------------------|
+| `libtelnetsrv.so`         | General telnet server library       |
+| `libtelnetsrv_enb`        | eNodeB specific functions           |
+| `libtelnetsrv_gnb`        | gNodeB specific functions           |
+| `libtelnetsrv_4GUE`       | 4G NR UE specific functions         |
+| `libtelnetsrv_5GUE`       | 5G NR UE specific functions         |
+| `libtelnetsrv_ci`         | gNB specific CI functions           |
+| `libtelnetsrv_ciUE`       | UE specific CI functions            |

 When starting the softmodem, you must specify the **_\-\-telnetsrv_** option to load and start the telnet server. The telnet server is loaded via the [oai shared library loader](loader).

@@ -19,6 +19,11 @@
 *      contact@openairinterface.org
 */

+/*! \file telnetsrv_ci.c
+ * \brief Implementation of telnet CI functions for gNB
+ * \note  This file contains telnet-related functions specific to 5G gNB.
+ */
+
 #include <sys/types.h>
 #include <stdio.h>
 #include <unistd.h>
@@ -0,0 +1,91 @@
+/*
+ * 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 telnetsrv_ciUE.c
+ * \brief Implementation of telnet CI functions for nrUE
+ * \author Guido Casati
+ * \date 2024
+ * \version 0.1
+ * \note This file contains telnet-related functions specific to 5G NR UE (nrUE).
+ */
+
+#include <sys/types.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <errno.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdarg.h>
+#include "openair2/LAYER2/NR_MAC_UE/mac_defs.h"
+#include "openair2/LAYER2/NR_MAC_UE/mac_proto.h"
+
+#define TELNETSERVERCODE
+#include "telnetsrv.h"
+
+#define ERROR_MSG_RET(mSG, aRGS...) do { prnt(mSG, ##aRGS); return 1; } while (0)
+
+/* UE L2 state string */
+const char* NR_UE_L2_STATE_STR[] = {
+#define UE_STATE(state) #state,
+  NR_UE_L2_STATES
+#undef UE_STATE
+};
+
+/**
+ * Get the synchronization state of a UE.
+ *
+ * @param buf    User input buffer containing UE ID
+ * @param debug  Debug flag (not used)
+ * @param prnt   Function to print output
+ * @return       0 on success, error code otherwise
+ */
+int get_sync_state(char *buf, int debug, telnet_printfunc_t prnt)
+{
+  int ue_id = -1;
+  if (!buf) {
+    ERROR_MSG_RET("no UE ID provided to telnet command\n");
+  } else {
+    ue_id = strtol(buf, NULL, 10);
+    if (ue_id < 0)
+      ERROR_MSG_RET("UE ID needs to be positive\n");
+  }
+  /* get sync state */
+  int sync_state = nr_ue_get_sync_state(ue_id);
+  prnt("UE sync state = %s\n", NR_UE_L2_STATE_STR[sync_state]);
+  return 0;
+}
+
+/* Telnet shell command definitions */
+static telnetshell_cmddef_t cicmds[] = {
+  {"sync_state", "[UE_ID(int,opt)]", get_sync_state},
+  {"", "", NULL},
+};
+
+/* Telnet shell variable definitions (if needed) */
+static telnetshell_vardef_t civars[] = {
+  {"", 0, 0, NULL}
+};
+
+/* Add CI UE commands */
+void add_ciUE_cmds(void) {
+  add_telnetcmd("ciUE", civars, cicmds);
+}
+