ofh: added the static and dynamic Control-Plane packet builders

Author: AlaiaL

include/srsran/ofh/ofh_factories.h

@@ -38,8 +38,11 @@ class iq_decompressor;
 class iq_compressor;
 class ota_symbol_boundary_notifier;
 
-/// Creates an Open Fronthaul Control-Plane packet builder.
-std::unique_ptr<cplane_message_builder> create_ofh_control_plane_packet_builder();
+/// Creates an Open Fronthaul Control-Plane static compression message builder.
+std::unique_ptr<cplane_message_builder> create_ofh_control_plane_static_compression_message_builder();
+
+/// Creates an Open Fronthaul Control-Plane dynamic compression message builder.
+std::unique_ptr<cplane_message_builder> create_ofh_control_plane_dynamic_compression_message_builder();
 
 /// Creates an Open Fronthaul User-Plane packet builder with static compression header.
 std::unique_ptr<uplane_message_builder>

lib/ofh/ofh_factories.cpp

@@ -11,7 +11,8 @@
 #include "srsran/ofh/ofh_factories.h"
 #include "ofh_sector_impl.h"
 #include "receiver/ofh_receiver_impl.h"
-#include "serdes/ofh_cplane_message_builder_impl.h"
+#include "serdes/ofh_cplane_message_builder_dynamic_compression_impl.h"
+#include "serdes/ofh_cplane_message_builder_static_compression_impl.h"
 #include "serdes/ofh_uplane_message_builder_dynamic_compression_impl.h"
 #include "serdes/ofh_uplane_message_builder_static_compression_impl.h"
 #include "serdes/ofh_uplane_message_decoder_dynamic_compression_impl.h"
@@ -50,7 +51,9 @@ create_data_flow_cplane_sched(const transmitter_config&
   config.frame_pool             = std::move(frame_pool);
   config.eth_builder            = ether::create_vlan_frame_builder();
   config.ecpri_builder          = ecpri::create_ecpri_packet_builder();
-  config.cp_builder             = ofh::create_ofh_control_plane_packet_builder();
+  config.cp_builder             = (tx_config.is_downlink_static_comp_hdr_enabled)
+                                      ? ofh::create_ofh_control_plane_static_compression_message_builder()
+                                      : ofh::create_ofh_control_plane_dynamic_compression_message_builder();
 
   config.nof_symbols = get_nsymb_per_slot(tx_config.cp);
   config.ru_nof_prbs =
@@ -107,9 +110,14 @@ create_data_flow_uplane_data(const transmitter_config&              tx_config,
   return std::make_unique<data_flow_uplane_downlink_data_impl>(std::move(config));
 }
 
-std::unique_ptr<cplane_message_builder> srsran::ofh::create_ofh_control_plane_packet_builder()
+std::unique_ptr<cplane_message_builder> srsran::ofh::create_ofh_control_plane_static_compression_message_builder()
 {
-  return std::make_unique<cplane_message_builder_impl>();
+  return std::make_unique<cplane_message_builder_static_compression_impl>();
+}
+
+std::unique_ptr<cplane_message_builder> srsran::ofh::create_ofh_control_plane_dynamic_compression_message_builder()
+{
+  return std::make_unique<cplane_message_builder_dynamic_compression_impl>();
 }
 
 std::unique_ptr<uplane_message_builder>

lib/ofh/serdes/CMakeLists.txt

@@ -7,7 +7,9 @@
 #
 
 set(SOURCES
+        ofh_cplane_message_builder_dynamic_compression_impl.cpp
         ofh_cplane_message_builder_impl.cpp
+        ofh_cplane_message_builder_static_compression_impl.cpp
         ofh_uplane_message_builder_impl.cpp
         ofh_uplane_message_builder_dynamic_compression_impl.cpp
         ofh_uplane_message_builder_static_compression_impl.cpp

lib/ofh/serdes/ofh_cplane_message_builder_dynamic_compression_impl.cpp

@@ -0,0 +1,35 @@
+/*
+ *
+ * Copyright 2021-2023 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.
+ *
+ */
+
+#include "ofh_cplane_message_builder_dynamic_compression_impl.h"
+#include "../support/network_order_binary_serializer.h"
+
+using namespace srsran;
+using namespace ofh;
+
+void cplane_message_builder_dynamic_compression_impl::serialize_compression_header(
+    network_order_binary_serializer& serializer,
+    const ru_compression_params&     compr,
+    data_direction                   direction) const
+{
+  // Downlink always encodes a 0.
+  if (direction == data_direction::downlink) {
+    static constexpr uint8_t reserved = 0;
+    serializer.write(reserved);
+
+    return;
+  }
+
+  uint8_t value = 0;
+  value |= uint8_t(compr.data_width) << 4;
+  value |= uint8_t(to_value(compr.type));
+
+  serializer.write(value);
+}

lib/ofh/serdes/ofh_cplane_message_builder_dynamic_compression_impl.h

@@ -0,0 +1,29 @@
+/*
+ *
+ * Copyright 2021-2023 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 "ofh_cplane_message_builder_impl.h"
+
+namespace srsran {
+namespace ofh {
+
+/// Open Fronthaul Control-Plane message builder for dynamic compression.
+class cplane_message_builder_dynamic_compression_impl : public cplane_message_builder_impl
+{
+private:
+  // See interface for documentation
+  void serialize_compression_header(network_order_binary_serializer& serializer,
+                                    const ru_compression_params&     compr,
+                                    data_direction                   direction) const override;
+};
+
+} // namespace ofh
+} // namespace srsran

lib/ofh/serdes/ofh_cplane_message_builder_impl.cpp

@@ -15,17 +15,6 @@
 using namespace srsran;
 using namespace ofh;
 
-/// Serializes the compression header using the given serializer and compression parameters.
-static void serialize_compression_header(ofh::network_order_binary_serializer& serializer,
-                                         const ru_compression_params&          compr)
-{
-  uint8_t value = 0;
-  value |= uint8_t(compr.data_width) << 4;
-  value |= uint8_t(to_value(compr.type));
-
-  serializer.write(value);
-}
-
 /// Encodes and returns the frame structure field. It is comprised by 4 LSB bits storing subcarrier spacing and 4 MSB
 /// bits storing the FFT/iFFT size.
 static uint8_t encode_frame_structure(cplane_scs scs, cplane_fft_size fft_size)
@@ -160,7 +149,7 @@ cplane_message_builder_impl::build_dl_ul_radio_channel_message(span<uint8_t>
   serializer.write(section_type);
 
   // Compression header (1 Byte).
-  serialize_compression_header(serializer, msg_params.comp_params);
+  serialize_compression_header(serializer, msg_params.comp_params, msg_params.radio_hdr.direction);
 
   // Reserved (1 Byte).
   static constexpr uint8_t reserved = 0U;
@@ -314,7 +303,7 @@ cplane_message_builder_impl::build_prach_mixed_numerology_message(span<uint8_t>
   serializer.write(uint16_t(msg_params.cpLength));
 
   // Compression header (1 Byte).
-  serialize_compression_header(serializer, msg_params.comp_params);
+  serialize_compression_header(serializer, msg_params.comp_params, msg_params.radio_hdr.direction);
 
   // Write the section fields. Only one section supported.
   serialize_section_3(serializer, msg_params.section_fields);

lib/ofh/serdes/ofh_cplane_message_builder_impl.h

@@ -15,6 +15,8 @@
 namespace srsran {
 namespace ofh {
 
+class network_order_binary_serializer;
+
 /// Open Fronthaul Control-Plane message builder implementation.
 class cplane_message_builder_impl : public cplane_message_builder
 {
@@ -30,6 +32,12 @@ class cplane_message_builder_impl : public cplane_message_builder
   // See interface for documentation.
   unsigned build_prach_mixed_numerology_message(span<uint8_t>                          buffer,
                                                 const cplane_section_type3_parameters& msg_params) override;
+
+private:
+  /// Serializes the compression header using the given serializer, compression parameters and direction.
+  virtual void serialize_compression_header(network_order_binary_serializer& serializer,
+                                            const ru_compression_params&     compr,
+                                            data_direction                   direction) const = 0;
 };
 
 } // namespace ofh

lib/ofh/serdes/ofh_cplane_message_builder_static_compression_impl.cpp

@@ -0,0 +1,25 @@
+/*
+ *
+ * Copyright 2021-2023 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.
+ *
+ */
+
+#include "ofh_cplane_message_builder_static_compression_impl.h"
+#include "../support/network_order_binary_serializer.h"
+
+using namespace srsran;
+using namespace ofh;
+
+void cplane_message_builder_static_compression_impl::serialize_compression_header(
+    network_order_binary_serializer& serializer,
+    const ru_compression_params&     compr,
+    data_direction                   direction) const
+{
+  // Static compression always encodes a 0.
+  static constexpr uint8_t reserved = 0;
+  serializer.write(reserved);
+}

lib/ofh/serdes/ofh_cplane_message_builder_static_compression_impl.h

@@ -0,0 +1,29 @@
+/*
+ *
+ * Copyright 2021-2023 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 "ofh_cplane_message_builder_impl.h"
+
+namespace srsran {
+namespace ofh {
+
+/// Open Fronthaul Control-Plane message builder for static compression.
+class cplane_message_builder_static_compression_impl : public cplane_message_builder_impl
+{
+private:
+  // See interface for documentation
+  void serialize_compression_header(network_order_binary_serializer& serializer,
+                                    const ru_compression_params&     compr,
+                                    data_direction                   direction) const override;
+};
+
+} // namespace ofh
+} // namespace srsran

tests/unittests/ofh/serdes/CMakeLists.txt

@@ -8,10 +8,18 @@
 
 set_directory_properties(PROPERTIES LABELS "serdes")
 
+add_executable(ofh_cplane_packet_builder_dynamic_compression_impl_test ofh_cplane_packet_builder_dynamic_compression_impl_test.cpp)
+target_link_libraries(ofh_cplane_packet_builder_dynamic_compression_impl_test srsran_ofh_message_serdes srsran_support gtest gtest_main)
+gtest_discover_tests(ofh_cplane_packet_builder_dynamic_compression_impl_test)
+
 add_executable(ofh_cplane_packet_builder_impl_test ofh_cplane_packet_builder_impl_test.cpp)
 target_link_libraries(ofh_cplane_packet_builder_impl_test srsran_ofh_message_serdes srsran_support gtest gtest_main)
 gtest_discover_tests(ofh_cplane_packet_builder_impl_test)
 
+add_executable(ofh_cplane_packet_builder_static_compression_impl_test ofh_cplane_packet_builder_static_compression_impl_test.cpp)
+target_link_libraries(ofh_cplane_packet_builder_static_compression_impl_test srsran_ofh_message_serdes srsran_support gtest gtest_main)
+gtest_discover_tests(ofh_cplane_packet_builder_static_compression_impl_test)
+
 add_executable(ofh_uplane_packet_builder_dynamic_impl_test ofh_uplane_packet_builder_dynamic_impl_test.cpp)
 target_link_libraries(ofh_uplane_packet_builder_dynamic_impl_test srsran_ru_ofh srsran_support srsran_phy_support srsran_channel_precoder srslog gtest gtest_main)
 gtest_discover_tests(ofh_uplane_packet_builder_dynamic_impl_test)