Skip to content

Commit d1f3353

Browse files
committed
added comments
1 parent b4b2ac5 commit d1f3353

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

vpr/src/pack/re_cluster_util.h

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,13 @@ void remove_mol_from_cluster(const t_pack_molecule* molecule,
7777
* @param router_data: returns the intra logic block router data.
7878
* @param temp_cluster_pr: returns the partition region of the new cluster.
7979
* @param temp_cluster_noc_grp_id returns the NoC group ID of the new cluster
80-
* @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY
81-
* specifies whether or not to run intra-cluster routing-based legality checking
82-
* after adding the molecule to the cluster; default is the more conservative option,
83-
* which is used in the top level re-clustering API functions
80+
* @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY.
81+
* This argument specifies whether or not to run an intra-cluster routing-based legality
82+
* check after adding the molecule to the cluster; default is the more conservative option.
83+
* This argument is passed down to try_pack_mol; if E_DETAILED_ROUTE_AT_END_ONLY is passed,
84+
* the function does not run a detailed intra-cluster routing-based legality check.
85+
* If many molecules will be added to a cluster, this option enables use of a single
86+
* routing check on the completed cluster (vs many incremental checks).
8487
*/
8588
bool start_new_cluster_for_mol(t_pack_molecule* molecule,
8689
const t_logical_block_type_ptr& type,
@@ -106,6 +109,14 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
106109
* @param clustering_data: A data structure containing helper data for the clustering process
107110
* (is updated if this function is called during packing, especially intra_lb_routing data member).
108111
* @param router_data: returns the intra logic block router data.
112+
* @param temp_cluster_noc_grp_id returns the NoC group ID of the new cluster
113+
* @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY.
114+
* This argument specifies whether or not to run an intra-cluster routing-based legality
115+
* check after adding the molecule to the cluster; default is the more conservative option.
116+
* This argument is passed down to try_pack_mol; if E_DETAILED_ROUTE_AT_END_ONLY is passed,
117+
* the function does not run a detailed intra-cluster routing-based legality check.
118+
* If many molecules will be added to a cluster, this option enables use of a single
119+
* routing check on the completed cluster (vs many incremental checks).
109120
*/
110121
bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
111122
int molecule_size,
@@ -115,7 +126,7 @@ bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
115126
t_clustering_data& clustering_data,
116127
t_lb_router_data*& router_data,
117128
NocGroupId& temp_cluster_noc_grp_id,
118-
enum e_detailed_routing_stages detailed_routing_stage = E_DETAILED_ROUTE_FOR_EACH_ATOM);
129+
enum e_detailed_routing_stages detailed_routing_stage = E_DETAILED_ROUTE_FOR_EACH_ATOM);
119130

120131
/**
121132
* @brief A function that fix the clustered netlist if the move is performed

0 commit comments

Comments
 (0)