Skip to content

Commit 2468e8a

Browse files
committed
[vpr][pack] add doxygen comment for alloc_and_load_pb_route
1 parent 623132e commit 2468e8a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

vpr/src/pack/cluster_router.h

+10
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ bool try_intra_lb_route(t_lb_router_data* router_data, int verbosity, t_mode_sel
2323
void reset_intra_lb_route(t_lb_router_data* router_data);
2424

2525
/* Accessor Functions */
26+
/**
27+
* @brief Creates an array [0..num_pb_graph_pins-1] for intra-logic block routing lookup.
28+
* Given a pb_graph_pin ID for a CLB, this lookup returns t_pb_route corresponding to that
29+
* pin.
30+
*
31+
* @param intra_lb_nets Vector of intra-logic block nets.
32+
* @param logic_block_type Logic block type of the current cluster.
33+
* @param intra_lb_pb_pin_lookup Intra-logic block pin lookup to get t_pb_graph_pin from a pin ID.
34+
* @return t_pb_routes An array [0..num_pb_graph_pins-1] for intra-logic block routing lookup.
35+
*/
2636
t_pb_routes alloc_and_load_pb_route(const std::vector<t_intra_lb_net>* intra_lb_nets,
2737
t_logical_block_type_ptr logic_block_type,
2838
const IntraLbPbPinLookup& intra_lb_pb_pin_lookup);

0 commit comments

Comments
 (0)