Skip to content

Commit 0fbc84b

Browse files
committed
[VPR] Update code comments
1 parent 1cc01db commit 0fbc84b

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

vpr/src/device/rr_spatial_lookup.h

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class RRSpatialLookup {
4040
* @brief Returns the index of the specified routing resource node.
4141
*
4242
* @param (x, y) are the grid location within the FPGA
43-
* @oaram rr_type specifies the type of resource,
43+
* @param rr_type specifies the type of resource,
4444
* @param ptc gives a unique number of resources of that type (e.g. CHANX) at that (x,y).
4545
*
4646
* @note All ptcs start at 0 and are positive.
@@ -74,8 +74,8 @@ class RRSpatialLookup {
7474
/**
7575
* @brief Returns the indices of the specified routing resource nodes, representing routing tracks in a channel.
7676
*
77-
* - (x, y) are the coordinate of the routing channel within the FPGA
78-
* - rr_type specifies the type of routing channel, either x-direction or y-direction
77+
* @param (x, y) are the coordinate of the routing channel within the FPGA
78+
* @param rr_type specifies the type of routing channel, either x-direction or y-direction
7979
*
8080
* @note
8181
* - Return an empty list if there are no routing channel at the given (x, y) location
@@ -121,14 +121,15 @@ class RRSpatialLookup {
121121
/**
122122
* @brief Register a node in the fast look-up
123123
*
124-
* - You must have a valid node id to register the node in the lookup
125-
* - (x, y) are the coordinate of the node to be indexable in the fast look-up
126-
* - type is the type of a node
127-
* - ptc is a feature number of a node, which can be
128-
* - the class number of a common SINK/SOURCE node of grid,
129-
* - pin index in a tile when type is OPIN/IPIN
130-
* - track index in a routing channel when type is CHANX/CHANY
131-
* - side is the side of node on the tile, applicable to OPIN/IPIN
124+
* @note You must have a valid node id to register the node in the lookup
125+
*
126+
* @param (x, y) are the coordinate of the node to be indexable in the fast look-up
127+
* @param type is the type of a node
128+
* @param ptc is a feature number of a node, which can be
129+
* - the class number of a common SINK/SOURCE node of grid,
130+
* - pin index in a tile when type is OPIN/IPIN
131+
* - track index in a routing channel when type is CHANX/CHANY
132+
* @param side is the side of node on the tile, applicable to OPIN/IPIN
132133
*
133134
* @note a node added with this call will not create a node in the rr_graph_storage node list
134135
* You MUST add the node in the rr_graph_storage so that the node is valid

0 commit comments

Comments
 (0)