Merge branch 'dev' into agpl_main

andrepuschmann · andrepuschmann · commit 77be7d3391d4 · 2023-02-22T21:35:31.000+01:00
diff --git a/.gitlab/ci/retina_request_rf.yml b/.gitlab/ci/retina_request_rf.yml
@@ -29,7 +29,7 @@
 
 - name: srs-gnb
   type: gnb
-  image: registry.gitlab.com/softwareradiosystems/retina/images/srsgnb:0.1.1_0.2.0
+  image: registry.gitlab.com/softwareradiosystems/retina/images/srsgnb:0.1.1_0.2.2
   resources:
     - type: sdr
       model: b200 
diff --git a/.gitlab/ci/retina_request_zmq.yml b/.gitlab/ci/retina_request_zmq.yml
@@ -28,7 +28,7 @@
 
 - name: srs-gnb
   type: gnb
-  image: registry.gitlab.com/softwareradiosystems/retina/images/srsgnb:0.1.1_0.2.0
+  image: registry.gitlab.com/softwareradiosystems/retina/images/srsgnb:0.1.1_0.2.2
   resources:
     - type: zmq
   path: ../../build/apps/gnb/gnb
diff --git a/apps/gnb/gnb_appconfig_cli11_schema.cpp b/apps/gnb/gnb_appconfig_cli11_schema.cpp
@@ -54,7 +54,7 @@ static void configure_cli11_log_args(CLI::App& app, log_appconfig& log_params)
   app.add_option("--sdap_level", log_params.sdap_level, "SDAP log level")->capture_default_str()->check(level_check);
   app.add_option("--gtpu_level", log_params.gtpu_level, "GTPU log level")->capture_default_str()->check(level_check);
   app.add_option("--fapi_level", log_params.fapi_level, "FAPI log level")->capture_default_str()->check(level_check);
-  app.add_option("--hex_max_size", log_params.hex_max_size, "Number of bytes to print in hex")
+  app.add_option("--hex_max_size", log_params.hex_max_size, "Maximum number of bytes to print in hex")
       ->capture_default_str()
       ->check(CLI::Range(0, 1024));
   app.add_option("--broadcast_enabled",
@@ -63,12 +63,10 @@ static void configure_cli11_log_args(CLI::App& app, log_appconfig& log_params)
       ->always_capture_default();
   app.add_option("--phy_rx_symbols_filename",
                  log_params.phy_rx_symbols_filename,
-                 "Set to a valid file path to print the received symbols.")
+                 "Set to a valid file path to print the received symbols")
       ->always_capture_default();
 
-  /// Post-parsing callback. This allows us to
-  /// set the log level to "all" level, if no level
-  /// is provided.
+  // Post-parsing callback. This allows us to set the log level to "all" level, if no level is provided.
   app.callback([&]() {
     if (app.count("--app_level") == 0) {
       log_params.app_level = log_params.all_level;
@@ -132,14 +130,14 @@ static void configure_cli11_rf_driver_args(CLI::App& app, rf_driver_appconfig& r
 {
   app.add_option("--srate", rf_driver_params.srate_MHz, "Sample rate in MHz")->capture_default_str();
   app.add_option("--device_driver", rf_driver_params.device_driver, "Device driver name")->capture_default_str();
-  app.add_option("--device_args", rf_driver_params.device_arguments, "Optional device arguments.")
+  app.add_option("--device_args", rf_driver_params.device_arguments, "Optional device arguments")
       ->capture_default_str();
-  app.add_option("--tx_gain", rf_driver_params.tx_gain_dB, "Transmit gain in decibels.")->capture_default_str();
-  app.add_option("--rx_gain", rf_driver_params.rx_gain_dB, "Receive gain in decibels.")->capture_default_str();
-  app.add_option("--lo_offset", rf_driver_params.lo_offset_MHz, "LO frequency offset in MHz.")->capture_default_str();
-  app.add_option("--clock", rf_driver_params.clock_source, "Clock source.")->capture_default_str();
-  app.add_option("--sync", rf_driver_params.synch_source, "Time synchronization source.")->capture_default_str();
-  app.add_option("--otw_format", rf_driver_params.otw_format, "Over-the-wire format.")->capture_default_str();
+  app.add_option("--tx_gain", rf_driver_params.tx_gain_dB, "Transmit gain in decibels")->capture_default_str();
+  app.add_option("--rx_gain", rf_driver_params.rx_gain_dB, "Receive gain in decibels")->capture_default_str();
+  app.add_option("--lo_offset", rf_driver_params.lo_offset_MHz, "LO frequency offset in MHz")->capture_default_str();
+  app.add_option("--clock", rf_driver_params.clock_source, "Clock source")->capture_default_str();
+  app.add_option("--sync", rf_driver_params.synch_source, "Time synchronization source")->capture_default_str();
+  app.add_option("--otw_format", rf_driver_params.otw_format, "Over-the-wire format")->capture_default_str();
   app.add_option_function<std::string>(
          "--time_alignment_calibration",
          [&rf_driver_params](const std::string& value) {
@@ -152,7 +150,7 @@ static void configure_cli11_rf_driver_args(CLI::App& app, rf_driver_appconfig& r
          },
          "Rx to Tx radio time alignment calibration in samples.\n"
          "Positive values reduce the RF transmission delay with respect\n"
-         "to the RF reception, while negative values increase it.")
+         "to the RF reception, while negative values increase it")
       ->check([](const std::string& value) -> std::string {
         // Check for valid option "auto".
         if (value == "auto") {
@@ -168,17 +166,17 @@ static void configure_cli11_rf_driver_args(CLI::App& app, rf_driver_appconfig& r
 
 static void configure_cli11_expert_phy_args(CLI::App& app, expert_phy_appconfig& expert_phy_params)
 {
-  app.add_option("--nof_ul_threads", expert_phy_params.nof_ul_threads, "Number of threads to process uplink.")
+  app.add_option("--nof_ul_threads", expert_phy_params.nof_ul_threads, "Number of threads to process uplink")
       ->capture_default_str()
       ->check(CLI::Number);
   app.add_option("--pusch_dec_max_iterations",
                  expert_phy_params.pusch_decoder_max_iterations,
-                 "Maximum number of PUSCH LDPC decoder iterations.")
+                 "Maximum number of PUSCH LDPC decoder iterations")
       ->capture_default_str()
       ->check(CLI::Number);
   app.add_option("--pusch_dec_enable_early_stop",
                  expert_phy_params.pusch_decoder_early_stop,
-                 "Enables PUSCH LDPC decoder early stop.")
+                 "Enables PUSCH LDPC decoder early stop")
       ->capture_default_str();
 }
 
@@ -224,7 +222,9 @@ static void configure_cli11_prach_args(CLI::App& app, prach_appconfig& prach_par
 
 static void configure_cli11_amplitude_control_args(CLI::App& app, amplitude_control_appconfig& amplitude_params)
 {
-  app.add_option("--tx_gain_backoff", amplitude_params.gain_backoff_dB, "Gain back-off to accommodate the signal PAPR")
+  app.add_option("--tx_gain_backoff",
+                 amplitude_params.gain_backoff_dB,
+                 "Gain back-off to accommodate the signal PAPR in decibels")
       ->capture_default_str();
   app.add_option("--enable_clipping", amplitude_params.enable_clipping, "Signal clipping")->capture_default_str();
   app.add_option("--ceiling", amplitude_params.power_ceiling_dBFS, "Clipping ceiling referenced to full scale")
@@ -234,7 +234,7 @@ static void configure_cli11_amplitude_control_args(CLI::App& app, amplitude_cont
 static void configure_cli11_common_cell_args(CLI::App& app, base_cell_appconfig& cell_params)
 {
   app.add_option("--pci", cell_params.pci, "PCI")->capture_default_str()->check(CLI::Range(0, 1007));
-  app.add_option("--dl_arfcn", cell_params.dl_arfcn, "Donwlink ARFCN")->capture_default_str();
+  app.add_option("--dl_arfcn", cell_params.dl_arfcn, "Downlink ARFCN")->capture_default_str();
   add_auto_enum_option(app, "--band", cell_params.band, "NR band");
   app.add_option("--common_scs", cell_params.common_scs, "Cell common subcarrier spacing")
       ->transform([](const std::string& value) {
@@ -323,17 +323,18 @@ static void configure_cli11_rlc_um_args(CLI::App& app, rlc_um_appconfig& rlc_um_
 static void configure_cli11_rlc_am_args(CLI::App& app, rlc_am_appconfig& rlc_am_params)
 {
   CLI::App* rlc_tx_am_subcmd = app.add_subcommand("tx", "AM TX parameters");
-  rlc_tx_am_subcmd->add_option("--sn", rlc_am_params.tx.sn_field_length, "RLC AM TX SN")->capture_default_str();
-  rlc_tx_am_subcmd->add_option("--t-poll-retransmit", rlc_am_params.tx.t_poll_retx, "RLC AM TX SN")
+  rlc_tx_am_subcmd->add_option("--sn", rlc_am_params.tx.sn_field_length, "RLC AM TX SN size")->capture_default_str();
+  rlc_tx_am_subcmd->add_option("--t-poll-retransmit", rlc_am_params.tx.t_poll_retx, "RLC AM TX t-PollRetransmit (ms)")
       ->capture_default_str();
-  rlc_tx_am_subcmd->add_option("--max-retx-threshold", rlc_am_params.tx.max_retx_thresh, "RLC AM TX SN")
+  rlc_tx_am_subcmd->add_option("--max-retx-threshold", rlc_am_params.tx.max_retx_thresh, "RLC AM max retx threshold")
       ->capture_default_str();
-  rlc_tx_am_subcmd->add_option("--poll-pdu", rlc_am_params.tx.poll_pdu, "RLC AM TX SN")->capture_default_str();
-  rlc_tx_am_subcmd->add_option("--poll-byte", rlc_am_params.tx.poll_byte, "RLC AM TX SN")->capture_default_str();
+  rlc_tx_am_subcmd->add_option("--poll-pdu", rlc_am_params.tx.poll_pdu, "RLC AM TX PollPdu")->capture_default_str();
+  rlc_tx_am_subcmd->add_option("--poll-byte", rlc_am_params.tx.poll_byte, "RLC AM TX PollByte")->capture_default_str();
   CLI::App* rlc_rx_am_subcmd = app.add_subcommand("rx", "AM RX parameters");
   rlc_rx_am_subcmd->add_option("--sn", rlc_am_params.rx.sn_field_length, "RLC AM RX SN")->capture_default_str();
-  rlc_rx_am_subcmd->add_option("--t-reassembly", rlc_am_params.rx.t_reassembly, "RLC AM RX SN")->capture_default_str();
-  rlc_rx_am_subcmd->add_option("--t-status-prohibit", rlc_am_params.rx.t_status_prohibit, "RLC AM RX SN")
+  rlc_rx_am_subcmd->add_option("--t-reassembly", rlc_am_params.rx.t_reassembly, "RLC AM RX t-Reassembly")
+      ->capture_default_str();
+  rlc_rx_am_subcmd->add_option("--t-status-prohibit", rlc_am_params.rx.t_status_prohibit, "RLC AM RX t-StatusProhibit")
       ->capture_default_str();
 }
 
@@ -375,7 +376,7 @@ void srsran::configure_cli11_with_gnb_appconfig_schema(CLI::App& app, gnb_appcon
   configure_cli11_rf_driver_args(*rf_driver_subcmd, gnb_cfg.rf_driver_cfg);
 
   // Common cell parameters.
-  CLI::App* common_cell_subcmd = app.add_subcommand("common_cell", "Common cell parameters")->configurable();
+  CLI::App* common_cell_subcmd = app.add_subcommand("cell_cfg", "Cell configuration")->configurable();
   configure_cli11_common_cell_args(*common_cell_subcmd, gnb_cfg.common_cell_cfg);
   // Configure the cells to use the common cell parameters once it has been parsed and before parsing the cells.
   common_cell_subcmd->parse_complete_callback([&gnb_cfg]() {
@@ -413,7 +414,7 @@ void srsran::configure_cli11_with_gnb_appconfig_schema(CLI::App& app, gnb_appcon
     // Prepare the radio bearers
     gnb_cfg.qos_cfg.resize(values.size());
 
-    //// Format every QoS setting.
+    // Format every QoS setting.
     for (unsigned i = 0, e = values.size(); i != e; ++i) {
       CLI::App subapp("QoS parameters");
       subapp.config_formatter(create_yaml_config_parser());
@@ -426,7 +427,6 @@ void srsran::configure_cli11_with_gnb_appconfig_schema(CLI::App& app, gnb_appcon
   app.add_option_function<std::vector<std::string>>("--qos", qos_lambda, "qos");
 
   // Expert PHY section.
-  CLI::App* expert_phy_subcmd =
-      app.add_subcommand("expert_phy", "Expert physical layer configuration.")->configurable();
+  CLI::App* expert_phy_subcmd = app.add_subcommand("expert_phy", "Expert physical layer configuration")->configurable();
   configure_cli11_expert_phy_args(*expert_phy_subcmd, gnb_cfg.expert_phy_cfg);
 }
diff --git a/apps/gnb/gnb_appconfig_translators.cpp b/apps/gnb/gnb_appconfig_translators.cpp
@@ -328,8 +328,10 @@ radio_configuration::radio srsran::generate_radio_config(const gnb_appconfig&
 
       // Add the tx ports.
       if (config.rf_driver_cfg.device_driver == "zmq") {
-        srsran_assert(sector_id * nof_ports + port_id < zmq_tx_addr.size(),
-                      "Transmission channel arguments out of bounds");
+        if (sector_id * nof_ports + port_id >= zmq_tx_addr.size()) {
+          report_error("ZMQ transmission channel arguments out of bounds");
+        }
+
         tx_ch_config.args = zmq_tx_addr[sector_id * nof_ports + port_id];
       }
       tx_stream_config.channels.emplace_back(tx_ch_config);
@@ -344,8 +346,10 @@ radio_configuration::radio srsran::generate_radio_config(const gnb_appconfig&
       rx_ch_config.gain_dB = config.rf_driver_cfg.rx_gain_dB;
 
       if (config.rf_driver_cfg.device_driver == "zmq") {
-        srsran_assert(sector_id * nof_ports + port_id < zmq_rx_addr.size(),
-                      "Reception channel arguments out of bounds");
+        if (sector_id * nof_ports + port_id >= zmq_rx_addr.size()) {
+          report_error("ZMQ reception channel arguments out of bounds");
+        }
+
         rx_ch_config.args = zmq_rx_addr[sector_id * nof_ports + port_id];
       }
       rx_stream_config.channels.emplace_back(rx_ch_config);
diff --git a/configs/gnb_rf_b200_tdd_n78_10mhz.yml b/configs/gnb_rf_b200_tdd_n78_10mhz.yml
@@ -0,0 +1,31 @@
+amf:
+  addr: 127.0.1.100                 # The address or hostname of the AMF.
+  bind_addr: 127.0.0.1              # A local IP that the gNB binds to for traffic from the AMF.
+
+rf_driver:
+  device_driver: uhd                # The RF driver name.
+  device_args: type=b200            # Optionally pass arguments to the selected RF driver.
+  clock:                            # Specify the clock source used by the RF.
+  sync:                             # Specify the sync source used by the RF.
+  srate: 11.52                      # RF sample rate might need to be adjusted according to selected bandwidth.
+  tx_gain: 50                       # Transmit gain of the RF might need to adjusted to the given situation.
+  rx_gain: 60                       # Receive gain of the RF might need to adjusted to the given situation.
+
+cell_cfg:
+  dl_arfcn: 632628                  # ARFCN of the downlink carrier (center frequency).
+  band: 78                          # The NR band.
+  channel_bandwidth_MHz: 10         # Bandwith in MHz. Number of PRBs will be automatically derived.
+  common_scs: 30                    # Subcarrier spacing in kHz used for data.
+  plmn: "00101"                     # PLMN broadcasted by the gNB.
+  tac: 7                            # Tracking area code (needs to match the core configuration).
+  pci: 1                            # Physical cell ID.
+      
+log:
+  filename: /tmp/gnb.log            # Path of the log file.
+  all_level: warning                # Logging level applied to all layers.
+
+pcap:
+  mac_enable: false                 # Set to true to enable MAC-layer PCAPs.
+  mac_filename: /tmp/gnb_mac.pcap   # Path where the MAC PCAP is stored.
+  ngap_enable: false                # Set to true to enable NGAP PCAPs.
+  ngap_filename: /tmp/gnb_ngap.pcap # Path where the NGAP PCAP is stored.
diff --git a/configs/gnb_rf_n310_fdd_n3_20mhz.yml b/configs/gnb_rf_n310_fdd_n3_20mhz.yml
@@ -0,0 +1,31 @@
+amf:
+  addr: 127.0.1.100                 # The address or hostname of the AMF.
+  bind_addr: 127.0.0.1              # A local IP that the gNB binds to for traffic from the AMF.
+
+rf_driver:
+  device_driver: uhd                # The RF driver name.
+  device_args: type=n3xx            # Optionally pass arguments to the selected RF driver.
+  clock: gpsdo                      # Specify the clock source used by the RF.
+  sync: gpsdo                       # Specify the sync source used by the RF.
+  srate: 30.72                      # RF sample rate might need to be adjusted according to selected bandwidth.
+  tx_gain: 35                       # Transmit gain of the RF might need to adjusted to the given situation.
+  rx_gain: 60                       # Receive gain of the RF might need to adjusted to the given situation.
+
+cell_cfg:
+  dl_arfcn: 368640                  # ARFCN of the downlink carrier (center frequency).
+  band: 3                           # The NR band.
+  channel_bandwidth_MHz: 20         # Bandwith in MHz. Number of PRBs will be automatically derived.
+  common_scs: 15                    # Subcarrier spacing in kHz used for data.
+  plmn: "00101"                     # PLMN broadcasted by the gNB.
+  tac: 7                            # Tracking area code (needs to match the core configuration).
+  pci: 1                            # Physical cell ID.
+
+log:
+  filename: /tmp/gnb.log            # Path of the log file.
+  all_level: warning                # Logging level applied to all layers.
+
+pcap:
+  mac_enable: false                 # Set to true to enable MAC-layer PCAPs.
+  mac_filename: /tmp/gnb_mac.pcap   # Path where the MAC PCAP is stored.
+  ngap_enable: false                # Set to true to enable NGAP PCAPs.
+  ngap_filename: /tmp/gnb_ngap.pcap # Path where the NGAP PCAP is stored.
