add comments regarding radio resource asn1 setting in the eNB

srsenb/hdr/stack/rrc/rrc_ue.h

@@ -103,7 +103,7 @@ private:
   srslte::byte_buffer_pool*           pool = nullptr;
   srslte::timer_handler::unique_timer activity_timer;
 
-  /// cached ASN1 for update checking, and ease of context transfer during HO
+  /// cached ASN1 fields for RRC config update checking, and ease of context transfer during HO
   asn1::rrc::rr_cfg_ded_s                current_rr_cfg;
   asn1::rrc::scell_to_add_mod_list_r10_l current_scells;
 

srsenb/hdr/stack/rrc/ue_rr_cfg.h

@@ -19,6 +19,27 @@
  *
  */
 
+/*----------------------------------------------------------------------------------------------------------------------
+ * \file
+ * These .h/.cc files contain the functions responsible for setting the ASN1 fields
+ * related to radio resource configuration from the eNB side (see TS 36.331 - 5.3.10)
+ *
+ * The following function naming convention is followed:
+ * - suffix "_enb_cfg" - any function related to setting asn1 fields based on the configuration passed to the eNB
+ *                       through parsed configuration files
+ * - suffix "_setup" -   the asn1 fields are set using the respective "_enb_cfg" function as default, plus any other
+ *                       parameter known at runtime (e.g. SR/CQI resources). Functions with this suffix are called
+ *                       during the rrcConnectionSetup and rrcConnectionReestablishment proceduress
+ * - suffix "_reconf" -  sets the asn1 fields that are known during the rrcConnectionReconfiguration. That includes
+ *                       "_enb_cfg" + "_setup" fields + DRBs + SCells, etc. It compares the current UE RRC configuration
+ *                       (accumulation of the RRC messages sent so far), with the next one that will result from
+ *                       the RRC setup/reestablishment/reconfiguration procedure. Based on this comparison, it will
+ *                       fill the output ASN1 struct with fields that are strictly necessary
+ * - suffix "_diff" -    update the struct relative to the current UE RRC config with the fields present in
+ *                       the Reconf/Setup/Reestablishment message that is about to be sent to the UE
+ *
+ *--------------------------------------------------------------------------------------------------------------------*/
+
 #ifndef SRSENB_UE_RR_CFG_H
 #define SRSENB_UE_RR_CFG_H
 
@@ -32,7 +53,7 @@ struct rrc_cfg_t;
 class cell_ctxt_dedicated_list;
 class bearer_cfg_handler;
 
-/// Fill RadioResourceConfigDedicated with RRCSetup/Reestablishment data
+/// Fill RadioResourceConfigDedicated with data known at the RRCSetup/Reestablishment stage
 void fill_rr_cfg_ded_setup(asn1::rrc::rr_cfg_ded_s&        rr_cfg,
                            const rrc_cfg_t&                enb_cfg,
                            const cell_ctxt_dedicated_list& ue_cell_list);
@@ -47,15 +68,18 @@ void apply_reconf_updates(asn1::rrc::rrc_conn_recfg_r8_ies_s&     recfg_r8,
                           const srslte::rrc_ue_capabilities_t&    ue_caps,
                           bool                                    phy_cfg_updated);
 
+/// Apply radioResourceConfigDedicated updates to the current UE RRC configuration
 void apply_rr_cfg_ded_diff(asn1::rrc::rr_cfg_ded_s&       current_rr_cfg_ded,
                            const asn1::rrc::rr_cfg_ded_s& pending_rr_cfg_ded);
 
+/// Fill rrcConnectionReconfiguration with SCells that were added/mod/removed since last RRC config update
 void fill_scells_reconf(asn1::rrc::rrc_conn_recfg_r8_ies_s&           recfg_r8,
                         const asn1::rrc::scell_to_add_mod_list_r10_l& current_scells,
                         const rrc_cfg_t&                              enb_cfg,
                         const cell_ctxt_dedicated_list&               ue_cell_list,
                         const srslte::rrc_ue_capabilities_t&          ue_caps);
 
+/// Apply Scell updates to the current UE RRC configuration
 void apply_scells_to_add_diff(asn1::rrc::scell_to_add_mod_list_r10_l&   current_scells,
                               const asn1::rrc::rrc_conn_recfg_r8_ies_s& recfg_r8);