added comments and changed arg type to enum

Author: KA7E

vpr/src/pack/re_cluster_util.cpp

@@ -130,7 +130,7 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                t_lb_router_data** router_data,
                                PartitionRegion& temp_cluster_pr,
                                NocGroupId& temp_cluster_noc_grp_id,
-                               const int& detailed_routing_stage) {
+                               enum e_detailed_routing_stages detailed_routing_stage) {
     auto& atom_ctx = g_vpr_ctx.atom();
     auto& floorplanning_ctx = g_vpr_ctx.mutable_floorplanning();
     auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
@@ -214,7 +214,7 @@ bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
                                   bool during_packing,
                                   t_clustering_data& clustering_data,
                                   t_lb_router_data*& router_data,
-                                  const int& detailed_routing_stage) {
+                                  enum e_detailed_routing_stages detailed_routing_stage) {
     auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
     auto& cluster_ctx = g_vpr_ctx.mutable_clustering();
 

vpr/src/pack/re_cluster_util.h

@@ -76,6 +76,10 @@ void remove_mol_from_cluster(const t_pack_molecule* molecule,
  *                          (is updated if this function is called during packing, especially intra_lb_routing data member).
  * @param router_data: returns the intra logic block router data.
  * @param temp_cluster_pr: returns the partition region of the new cluster.
+ * @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY
+ *                                 specifies whether or not to run intra-cluster routing-based legality checking
+ *                                 after adding the molecule to the cluster; default is the more conservative option,
+ *                                 which is used in the top level re-clustering API functions
  */
 bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                const t_logical_block_type_ptr& type,
@@ -89,7 +93,7 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                t_lb_router_data** router_data,
                                PartitionRegion& temp_cluster_pr,
                                NocGroupId& temp_cluster_noc_grp_id,
-                               const int& detailed_routing_stage = 1);
+                               enum e_detailed_routing_stages detailed_routing_stage = E_DETAILED_ROUTE_FOR_EACH_ATOM);
 
 /**
  * @brief A function that packs a molecule into an existing cluster