sched: improve comments of pucch resource manager

Signed-off-by: Carlo Galiotto <[email protected]>

Author: carlo-gal

lib/scheduler/pucch_scheduling/pucch_allocator_impl.cpp

@@ -1083,7 +1083,7 @@ pucch_harq_ack_grant pucch_allocator_impl::update_format2_grant(pucch_info&
 
   const pucch_harq_resource_alloc_record pucch_f2_harq_info =
       use_pucch_f2_csi_res ? pucch_harq_resource_alloc_record{.pucch_res = nullptr}
-                           : resource_manager.fetch_specific_f2_harq_resource(
+                           : resource_manager.fetch_allocated_f2_harq_resource(
                                  sl_tx,
                                  existing_f2_grant.crnti,
                                  ue_cell_cfg.cfg_dedicated().ul_config.value().init_ul_bwp.pucch_cfg.value());

lib/scheduler/pucch_scheduling/pucch_resource_manager.cpp

@@ -281,9 +281,9 @@ int pucch_resource_manager::fetch_f2_pucch_res_indic(slot_point slot_tx, rnti_t
 }
 
 const pucch_harq_resource_alloc_record
-pucch_resource_manager::fetch_specific_f2_harq_resource(slot_point          slot_harq,
-                                                        rnti_t              crnti,
-                                                        const pucch_config& pucch_cfg)
+pucch_resource_manager::fetch_allocated_f2_harq_resource(slot_point          slot_harq,
+                                                         rnti_t              crnti,
+                                                         const pucch_config& pucch_cfg)
 {
   srsran_sanity_check(slot_harq < last_sl_ind + RES_MANAGER_RING_BUFFER_SIZE,
                       "PUCCH being allocated to far into the future");
@@ -308,7 +308,7 @@ pucch_resource_manager::fetch_specific_f2_harq_resource(slot_point          slot
 
   const auto& pucch_res_list = pucch_cfg.pucch_res_list;
 
-  // If there is an available resource, try to allocate it.
+  // If the resource is found, get the resource indicator and the configuration from the PUCCH resource list.
   if (target_ue_resource != slot_ue_res_array.end() and
       static_cast<unsigned>(target_ue_resource - slot_ue_res_array.begin()) <
           pucch_cfg.pucch_res_set[PUCCH_HARQ_F2_RES_SET_ID].pucch_res_id_list.size()) {

lib/scheduler/pucch_scheduling/pucch_resource_manager.h

@@ -124,11 +124,13 @@ class pucch_resource_manager
   /// \return PUCCH resource indicator of the resource used allocated to the UE; if UE is not found, returns -1.
   int fetch_f2_pucch_res_indic(slot_point slot_tx, rnti_t crnti, const pucch_config& pucch_cfg);
 
-  /// \brief Returns the configuration of the PUCCH Format 2 resource used for HARQ already allocated to a given RNTI at
-  /// a given slot.
-  /// \return Pointer to the resource configuration allocated to the UE; if UE is not found, returns \c nullptr.
+  /// \brief Fetches the configuration of the PUCCH Format 2 resource used for HARQ previously allocated to a given RNTI
+  /// for a given slot.
+  /// \return If the resource is found, it returns (i) the pointer to the configuration and (ii) the PUCCH resource
+  /// indicator corresponding to the PUCCH resource that previously allocated to the UE. Else, the pointer passed will
+  /// be \c nullptr, whereas the PUCCH resource indicator is to be ignored.
   const pucch_harq_resource_alloc_record
-  fetch_specific_f2_harq_resource(slot_point slot_harq, rnti_t crnti, const pucch_config& pucch_cfg);
+  fetch_allocated_f2_harq_resource(slot_point slot_harq, rnti_t crnti, const pucch_config& pucch_cfg);
 
   /// \brief Returns the configuration of the PUCCH resource used for CSI (format 2) for a given RNTI at a given slot.
   /// \return Pointer to the resource configuration used allocated to the UE; if UE is not found, returns \c nullptr.