ofh: added a notifier for late downlink messages

Author: AlaiaL

apps/gnb/gnb.cpp

@@ -127,7 +127,8 @@ static void configure_ru_ofh_executors_and_notifiers(ru_ofh_configuration&
                                                      const log_appconfig&                log_cfg,
                                                      worker_manager&                     workers,
                                                      ru_uplink_plane_rx_symbol_notifier& symbol_notifier,
-                                                     ru_timing_notifier&                 timing_notifier)
+                                                     ru_timing_notifier&                 timing_notifier,
+                                                     ru_error_notifier&                  error_notifier)
 {
   srslog::basic_logger& ofh_logger = srslog::fetch_basic_logger("OFH", false);
   ofh_logger.set_level(srslog::str_to_basic_level(log_cfg.ofh_level));
@@ -136,6 +137,7 @@ static void configure_ru_ofh_executors_and_notifiers(ru_ofh_configuration&
   dependencies.rt_timing_executor = workers.ru_timing_exec;
   dependencies.timing_notifier    = &timing_notifier;
   dependencies.rx_symbol_notifier = &symbol_notifier;
+  dependencies.error_notifier     = &error_notifier;
 
   // Configure sector.
   for (unsigned i = 0, e = config.sector_configs.size(); i != e; ++i) {
@@ -486,6 +488,7 @@ int main(int argc, char** argv)
 
   upper_ru_ul_adapter     ru_ul_adapt(gnb_cfg.cells_cfg.size());
   upper_ru_timing_adapter ru_timing_adapt(gnb_cfg.cells_cfg.size());
+  upper_ru_error_adapter  ru_error_adapt(gnb_cfg.cells_cfg.size());
 
   std::unique_ptr<radio_unit> ru_object;
   if (variant_holds_alternative<ru_ofh_configuration>(ru_cfg.config)) {
@@ -495,7 +498,8 @@ int main(int argc, char** argv)
                                              gnb_cfg.log_cfg,
                                              workers,
                                              ru_ul_adapt,
-                                             ru_timing_adapt);
+                                             ru_timing_adapt,
+                                             ru_error_adapt);
 
     ru_object = create_ofh_ru(variant_get<ru_ofh_configuration>(ru_cfg.config), std::move(ru_dependencies));
   } else if (variant_holds_alternative<ru_generic_configuration>(ru_cfg.config)) {
@@ -545,6 +549,7 @@ int main(int argc, char** argv)
     // Make connections between DU and RU.
     ru_ul_adapt.map_handler(sector_id, du->get_rx_symbol_handler());
     ru_timing_adapt.map_handler(sector_id, du->get_timing_handler());
+    ru_error_adapt.map_handler(sector_id, du->get_error_handler());
 
     // Start DU execution.
     du->start();

include/srsran/du/du.h

@@ -10,30 +10,34 @@
 
 #pragma once
 
-#include "srsran/f1ap/common/f1ap_common.h"
-#include "srsran/phy/upper/upper_phy_rx_symbol_handler.h"
-#include "srsran/phy/upper/upper_phy_timing_handler.h"
-
 namespace srsran {
 
+class f1ap_message_handler;
+class upper_phy_error_handler;
+class upper_phy_rx_symbol_handler;
+class upper_phy_timing_handler;
+
 class du
 {
 public:
   virtual ~du() = default;
 
-  /// \brief Start the DU.
+  /// Starts the DU.
   virtual void start() = 0;
 
-  /// \brief Stop the DU.
+  /// Stops the DU.
   virtual void stop() = 0;
 
-  /// \brief Get the handler for F1AP Rx PDUs coming from the CU-CP.
+  /// Returns the handler for F1AP Rx PDUs coming from the CU-CP.
   virtual f1ap_message_handler& get_f1ap_message_handler() = 0;
 
-  /// \brief Gets handler in charge of processing uplink OFDM symbols.
+  /// Returns a reference to the error handler of the DU.
+  virtual upper_phy_error_handler& get_error_handler() = 0;
+
+  /// Returns handler in charge of processing uplink OFDM symbols.
   virtual upper_phy_rx_symbol_handler& get_rx_symbol_handler() = 0;
 
-  /// \brief Returns a reference to the timing handler of the DU.
+  /// Returns a reference to the timing handler of the DU.
   virtual upper_phy_timing_handler& get_timing_handler() = 0;
 };
 

include/srsran/fapi/message_builders.h

@@ -1870,8 +1870,6 @@ inline slot_indication_message build_slot_indication_message(unsigned sfn, unsig
 inline error_indication_message
 build_error_indication(uint16_t sfn, uint16_t slot, message_type_id msg_id, error_code_id error_id)
 {
-  srsran_assert(error_id != error_code_id::out_of_sync, "OUT OF SYNC error is not allowed in this builder");
-
   error_indication_message msg;
 
   msg.message_type  = message_type_id::error_indication;

include/srsran/fapi_adaptor/phy/phy_fapi_adaptor.h

@@ -19,6 +19,7 @@ class slot_message_gateway;
 class slot_time_message_notifier;
 } // namespace fapi
 
+class upper_phy_error_notifier;
 class upper_phy_timing_notifier;
 class upper_phy_rx_results_notifier;
 
@@ -35,22 +36,25 @@ class phy_fapi_adaptor
 public:
   virtual ~phy_fapi_adaptor() = default;
 
-  /// \brief Returns a reference to the timing notifier used by the adaptor.
-  virtual upper_phy_timing_notifier& get_timing_notifier() = 0;
+  /// Returns a reference to the error notifier used by the adaptor.
+  virtual upper_phy_error_notifier& get_error_notifier() = 0;
 
-  /// \brief Returns a reference to the slot-based message gateway used by the adaptor.
-  virtual fapi::slot_message_gateway& get_slot_message_gateway() = 0;
+  /// Returns a reference to the timing notifier used by the adaptor.
+  virtual upper_phy_timing_notifier& get_timing_notifier() = 0;
 
-  /// \brief Returns a reference to the results notifier used by the adaptor.
+  /// Returns a reference to the results notifier used by the adaptor.
   virtual upper_phy_rx_results_notifier& get_rx_results_notifier() = 0;
 
-  /// \brief Configures the slot-based, time-specific message notifier to the given one.
+  /// Returns a reference to the slot-based message gateway used by the adaptor.
+  virtual fapi::slot_message_gateway& get_slot_message_gateway() = 0;
+
+  /// Configures the slot-based, time-specific message notifier to the given one.
   virtual void set_slot_time_message_notifier(fapi::slot_time_message_notifier& fapi_time_notifier) = 0;
 
-  /// \brief Configures the slot-based, error-specific message notifier to the given one.
+  /// Configures the slot-based, error-specific message notifier to the given one.
   virtual void set_slot_error_message_notifier(fapi::slot_error_message_notifier& fapi_error_notifier) = 0;
 
-  /// \brief Configures the slot-based, data-specific message notifier to the given one.
+  /// Configures the slot-based, data-specific message notifier to the given one.
   virtual void set_slot_data_message_notifier(fapi::slot_data_message_notifier& fapi_data_notifier) = 0;
 };
 

include/srsran/ofh/ofh_error_notifier.h

@@ -0,0 +1,39 @@
+/*
+ *
+ * Copyright 2021-2024 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#pragma once
+
+#include "srsran/ran/slot_point.h"
+
+namespace srsran {
+namespace ofh {
+
+/// Open Fronthaul error context.
+struct error_context {
+  /// Slot context.
+  slot_point slot;
+  /// Radio sector identifier.
+  unsigned sector;
+};
+
+/// Open Fronthaul error notifier.
+class error_notifier
+{
+public:
+  virtual ~error_notifier() = default;
+
+  /// \brief Notifies a late downlink message.
+  ///
+  /// \param[in] context Context of the error.
+  virtual void on_late_downlink_message(const error_context& context) = 0;
+};
+
+} // namespace ofh
+} // namespace srsran

include/srsran/ofh/ofh_sector.h

@@ -14,6 +14,7 @@ namespace srsran {
 namespace ofh {
 
 class controller;
+class error_notifier;
 class receiver;
 class transmitter;
 
@@ -33,6 +34,9 @@ class sector
 
   /// Returns the Open Fronthaul controller of this sector.
   virtual controller& get_controller() = 0;
+
+  /// Sets the error notifier of this sector to the given one.
+  virtual void set_error_notifier(error_notifier& notifier) = 0;
 };
 
 } // namespace ofh

include/srsran/ofh/ofh_sector_config.h

@@ -30,6 +30,8 @@ namespace ofh {
 
 /// Open Fronthaul sector configuration.
 struct sector_configuration {
+  /// Radio sector identifier.
+  unsigned sector_id;
   /// Ethernet interface name or identifier.
   std::string interface;
   /// Promiscuous mode flag.

include/srsran/ofh/transmitter/ofh_downlink_handler.h

@@ -17,6 +17,8 @@ class resource_grid_reader;
 
 namespace ofh {
 
+class error_notifier;
+
 /// Open Fronthaul downlink handler.
 class downlink_handler
 {
@@ -29,6 +31,9 @@ class downlink_handler
   /// \param[in] context Resource grid context.
   /// \param[in] grid Downlink data to transmit.
   virtual void handle_dl_data(const resource_grid_context& context, const resource_grid_reader& grid) = 0;
+
+  /// Sets the error notifier of this sector to the given one.
+  virtual void set_error_notifier(error_notifier& notifier) = 0;
 };
 
 } // namespace ofh

include/srsran/ofh/transmitter/ofh_transmitter.h

@@ -17,6 +17,8 @@
 namespace srsran {
 namespace ofh {
 
+class error_notifier;
+
 /// Open Fronthaul transmitter interface.
 class transmitter
 {
@@ -32,6 +34,9 @@ class transmitter
 
   /// Returns the OTA symbol boundary notifier of this Open Fronthaul transmitter.
   virtual ota_symbol_boundary_notifier& get_ota_symbol_boundary_notifier() = 0;
+
+  /// Sets the error notifier of this sector to the given one.
+  virtual void set_error_notifier(error_notifier& notifier) = 0;
 };
 
 } // namespace ofh

include/srsran/ofh/transmitter/ofh_transmitter_configuration.h

@@ -54,6 +54,8 @@ struct symbol_handler_config {
 
 /// Open Fronthaul transmitter configuration.
 struct transmitter_config {
+  /// Radio sector identifier.
+  unsigned sector;
   /// Channel bandwidth.
   bs_channel_bandwidth_fr1 bw;
   /// Subcarrier spacing.