Merge pull request #2946 from verilog-to-routing/3d_sb

3D SW Architecture

Author: soheilshahrouz

libs/libarchfpga/src/echo_arch.cpp

@@ -297,7 +297,7 @@ void PrintArchInfo(FILE* Echo, const t_arch* arch) {
                 int num_layers = (int)layout.layers.size();
                 if (num_layers > 1) {
                     fprintf(Echo, "\t\t\t\ttype unidir mux_name for between two dice connections: %s\n",
-                            arch->switches[seg.arch_opin_between_dice_switch].name.c_str());
+                            arch->switches[seg.arch_inter_die_switch].name.c_str());
                 }
             }
         } else { //Should be bidir

libs/libarchfpga/src/physical_types.h

@@ -1599,88 +1599,138 @@ enum e_Fc_type {
     FRACTIONAL
 };
 
-/* Lists all the important information about a certain segment type.  Only   *
- * used if the route_type is DETAILED.  [0 .. det_routing_arch.num_segment]  *
- * name: the name of this segment                                            *
- * frequency:  ratio of tracks which are of this segment type.               *
- * length:     Length (in clbs) of the segment.                              *
- * arch_wire_switch: Index of the switch type that connects other wires      *
- *                   *to* this segment. Note that this index is in relation  *
- *                   to the switches from the architecture file, not the     *
- *                   expanded list of switches that is built at the end of   *
- *                   build_rr_graph.                                         *
- * arch_opin_switch: Index of the switch type that connects output pins      *
- *                   (OPINs) *to* this segment. Note that this index is in   *
- *                   relation to the switches from the architecture file,    *
- *                   not the expanded list of switches that is built         *
- *                   at the end of build_rr_graph                            *
- * @param arch_wire_switch_dec: Same as arch_wire_switch but used only for   *
- *                   decremental tracks if it is specified in the            *
- *                   architecture file. If -1, this value was not set in     *
- *                   the architecture file and arch_wire_switch should be    *
- *                   used for "DEC_DIR" wire segments.                       *
- * @param arch_opin_switch_dec: Same as arch_opin_switch but used only for   *
- *                   decremental tracks if it is specified in the            *
- *                   architecture file. If -1, this value was not set in     * 
- *                   the architecture file and arch_opin_switch should be    *
- *                   used for "DEC_DIR" wire segments.                       * 
- * @param arch_opin_between_dice_switch: Index of the switch type that       *
- *                   connects output pins (OPINs) *to* this segment from     *
- *                   *another die (layer)*. Note that this index is in       *
- *                   relation to the switches from the architecture file,    *
- *                   not the expanded list of switches that is built at      *
- *                   the end of build_rr_graph                               *
- *                                                                           *
- * frac_cb:  The fraction of logic blocks along its length to which this     *
- *           segment can connect.  (i.e. internal population).               *
- * frac_sb:  The fraction of the length + 1 switch blocks along the segment  *
- *           to which the segment can connect.  Segments that aren't long    *
- *           lines must connect to at least two switch boxes.                *
- * parallel_axis:   Defines what axis the segment is parallel to. See        *
- *                  e_parallel_axis comments for more details on the values. *
- * Cmetal: Capacitance of a routing track, per unit logic block length.      *
- * Rmetal: Resistance of a routing track, per unit logic block length.       *
- * (UDSD by AY) drivers: How do signals driving a routing track connect to   *
- *                       the track?                                          *
- * seg_index: The index of the segment as stored in the appropriate Segs list*
- *            Upon loading the architecture, we use this field to keep track *
- *            the segment's index in the unified segment_inf vector. This is *
- *            useful when building the rr_graph for different Y & X channels *
- *            in terms of track distribution and segment type.               *
- * res_type: Determines the routing network to which the segment belongs.    *
- *           Possible values are:                                            *
- *              - GENERAL: The segment is part of the general routing        *
- *                         resources.                                        *
- *              - GCLK: The segment is part of the global routing network.   *
- *           For backward compatibility, this attribute is optional. If not  *
- *           specified, the resource type for the segment is considered to   *
- *           be GENERAL.                                                     *
- * meta: Table storing extra arbitrary metadata attributes.                  */
+/**
+ * @brief Lists all the important information about a certain segment type.  Only
+ * used if the route_type is DETAILED.  [0 .. det_routing_arch.num_segment]
+ */
 struct t_segment_inf {
+    /**
+     *  @brief The name of the segment type 
+     */
     std::string name;
+
+    /**
+     *  @brief ratio of tracks which are of this segment type. 
+     */
     int frequency;
+
+    /**
+     *  @brief Length (in clbs) of the segment. 
+     */
     int length;
+
+    /**
+     *  @brief Index of the switch type that connects other wires to this segment. 
+     * Note that this index is in relation to the switches from the architecture file, 
+     * not the expanded list of switches that is built at the end of build_rr_graph. 
+     */
     short arch_wire_switch;
+
+    /**
+     *  @brief Index of the switch type that connects output pins to this segment. 
+     * Note that this index is in relation to the switches from the architecture file, 
+     * not the expanded list of switches that is built at the end of build_rr_graph. 
+     */
     short arch_opin_switch;
+
+    /**
+     *  @brief Same as arch_wire_switch but used only for decremental tracks if it is 
+     * specified in the architecture file. If -1, this value was not set in the 
+     * architecture file and arch_wire_switch should be used for "DEC_DIR" wire segments. 
+     */
     short arch_wire_switch_dec = -1;
+
+    /**
+     *  @brief Same as arch_opin_switch but used only for decremental tracks if 
+     * it is specified in the architecture file. If -1, this value was not set in 
+     * the architecture file and arch_opin_switch should be used for "DEC_DIR" wire segments. 
+     */
     short arch_opin_switch_dec = -1;
-    short arch_opin_between_dice_switch = -1;
+
+    /**
+     *  @brief Index of the switch type that connects output pins (OPINs) to this 
+     * segment from another die (layer). Note that this index is in relation to 
+     * the switches from the architecture file, not the expanded list of switches 
+     * that is built at the end of build_rr_graph. 
+     */
+    short arch_inter_die_switch = -1;
+
+    /**
+     *  @brief The fraction of logic blocks along its length to which this segment can connect. 
+     * (i.e. internal population). 
+     */
     float frac_cb;
+
+    /**
+     *  @brief The fraction of the length + 1 switch blocks along the segment to which the segment can connect. 
+     * Segments that aren't long lines must connect to at least two switch boxes. 
+     */
     float frac_sb;
+
     bool longline;
+
+    /**
+     *  @brief The resistance of a routing track, per unit logic block length. */
     float Rmetal;
+
+    /**
+     *  @brief The capacitance of a routing track, per unit logic block length. */
     float Cmetal;
+
     enum e_directionality directionality;
+
+    /**
+     *  @brief Defines what axis the segment is parallel to. See e_parallel_axis 
+     * comments for more details on the values. 
+     */
     enum e_parallel_axis parallel_axis;
+
+    /**
+     *  @brief A vector of booleans indicating whether the segment can connect to a logic block. 
+     */
     std::vector<bool> cb;
+
+    /**
+     *  @brief A vector of booleans indicating whether the segment can connect to a switch block. 
+     */
     std::vector<bool> sb;
+
+    /**
+     *  @brief The index of the segment as stored in the appropriate Segs list.
+     * Upon loading the architecture, we use this field to keep track of the 
+     * segment's index in the unified segment_inf vector. This is useful when 
+     * building the rr_graph for different Y & X channels in terms of track 
+     * distribution and segment type. 
+     */
     int seg_index;
+
+    /**
+     *  @brief Determines the routing network to which the segment belongs.
+     *  Possible values are:
+     *   - GENERAL: The segment is part of the general routing resources.
+     *   - GCLK: The segment is part of the global routing network.
+     * For backward compatibility, this attribute is optional. If not specified, 
+     * the resource type for the segment is considered to be GENERAL.
+     */
     enum SegResType res_type = SegResType::GENERAL;
-    //float Cmetal_per_m; /* Wire capacitance (per meter) */
 };
 
 inline bool operator==(const t_segment_inf& a, const t_segment_inf& b) {
-    return a.name == b.name && a.frequency == b.frequency && a.length == b.length && a.arch_wire_switch == b.arch_wire_switch && a.arch_opin_switch == b.arch_opin_switch && a.arch_opin_between_dice_switch == b.arch_opin_between_dice_switch && a.frac_cb == b.frac_cb && a.frac_sb == b.frac_sb && a.longline == b.longline && a.Rmetal == b.Rmetal && a.Cmetal == b.Cmetal && a.directionality == b.directionality && a.parallel_axis == b.parallel_axis && a.cb == b.cb && a.sb == b.sb;
+    return a.name == b.name
+           && a.frequency == b.frequency
+           && a.length == b.length
+           && a.arch_wire_switch == b.arch_wire_switch
+           && a.arch_opin_switch == b.arch_opin_switch
+           && a.arch_inter_die_switch == b.arch_inter_die_switch
+           && a.frac_cb == b.frac_cb
+           && a.frac_sb == b.frac_sb
+           && a.longline == b.longline
+           && a.Rmetal == b.Rmetal
+           && a.Cmetal == b.Cmetal
+           && a.directionality == b.directionality
+           && a.parallel_axis == b.parallel_axis
+           && a.cb == b.cb
+           && a.sb == b.sb;
 }
 
 /*provide hashing for t_segment_inf to enable the use of many std containers.

libs/libarchfpga/src/read_xml_arch_file.cpp

@@ -3793,7 +3793,7 @@ static std::vector<t_segment_inf> ProcessSegments(pugi::xml_node Parent,
                 archfpga_throw(loc_data.filename_c_str(), loc_data.line(SubElem),
                                "'%s' is not a valid mux name.\n", tmp);
             }
-            Segs[i].arch_opin_between_dice_switch = switch_idx;
+            Segs[i].arch_inter_die_switch = switch_idx;
         }
 
         /* Get the wire and opin switches, or mux switch if unidir */

vpr/src/base/vpr_types.h

@@ -1359,70 +1359,124 @@ struct t_det_routing_arch {
 
 /**
  * @brief Lists detailed information about segmentation.  [0 .. W-1].
- *
- *   @param length     length of segment.
- *   @param start      index at which a segment starts in channel 0.
- *   @param longline   true if this segment spans the entire channel.
- *   @param sb  [0..length]: true for every channel intersection, relative to the
- *                     segment start, at which there is a switch box.
- *   @param cb  [0..length-1]:  true for every logic block along the segment at
- *                     which there is a connection box.
- *   @param arch_wire_switch  Index of the switch type that connects other wires
- *                     *to* this segment. Note that this index is in relation
- *                     to the switches from the architecture file, not the
- *                     expanded list of switches that is built at the end of
- *                     build_rr_graph.
- *   @param arch_opin_switch  Index of the switch type that connects output pins
- *                     (OPINs) *to* this segment. Note that this index is in
- *                     relation to the switches from the architecture file,
- *                     not the expanded list of switches that is is built
- *                     at the end of build_rr_graph
- *   @param arch_opin_between_dice_switch Index of the switch type that connects output
- *                     pins (OPINs) *to* this segment from *another dice*.
- *                     Note that this index is in relation to the switches from
- *                     the architecture file, not the expanded list of switches that is built
- *                     at the end of build_rr_graph
- *   @param Cmetal     Capacitance of a routing track, per unit logic block length.
- *   @param Rmetal     Resistance of a routing track, per unit logic block length.
- *   @param direction  The direction of a routing track.
- *   @param index      index of the segment type used for this track.
- *                     Note that this index will store the index of the segment
- *                     relative to its **parallel** segment types, not all segments
- *                     as stored in device_ctx. Look in rr_graph.cpp: build_rr_graph
- *                     for details but here is an example: say our segment_inf_vec in
- *                     device_ctx is as follows: [seg_a_x, seg_b_x, seg_a_y, seg_b_y]
- *                     when building the rr_graph, static segment_inf_vectors will be
- *                     created for each direction, thus you will have the following
- *                     2 vectors: X_vec =[seg_a_x,seg_b_x] and Y_vec = [seg_a_y,seg_b_y].
- *                     As a result, e.g. seg_b_y::index == 1 (index in Y_vec)
- *                     and != 3 (index in device_ctx segment_inf_vec).
- *   @param abs_index  index is relative to the segment_inf vec as stored in device_ctx.
- *                     Note that the above vector is **unifies** both x-parallel and
- *                     y-parallel segments and is loaded up originally in read_xml_arch_file.cpp
- *
- *   @param type_name_ptr  pointer to name of the segment type this track belongs
- *                     to. points to the appropriate name in s_segment_inf
  */
 struct t_seg_details {
+    /**
+     *  @brief Length (in clbs) of the segment. 
+     */
     int length = 0;
+
+    /**
+     *  @brief Index at which a segment starts in channel 0. 
+     */
     int start = 0;
+
+    /**
+     *  @brief True if this segment spans the entire channel.
+     */
     bool longline = false;
+
+    /**
+     *  @brief [0..length]: true for every channel intersection, relative to the 
+     *  segment start, at which there is a switch box.
+     */
     std::unique_ptr<bool[]> sb;
+
+    /**
+     *  @brief [0..length]: true for every logic block along the segment at
+     *  which there is a connection box.
+     */
     std::unique_ptr<bool[]> cb;
+
+    /**
+     *  @brief Index of the switch type that connects other wires to this segment.
+     *  Note that this index is in relation to the switches from the architecture 
+     *  file, not the expanded list of switches that is built at the end of build_rr_graph.
+     */
     short arch_wire_switch = 0;
+
+    /**
+     *  @brief Index of the switch type that connects output pins (OPINs) *to* this segment.
+     *  Note that this index is in relation to the switches from the architecture 
+     *  file, not the expanded list of switches that is built at the end of build_rr_graph.
+     */
     short arch_opin_switch = 0;
-    short arch_opin_between_dice_switch = 0;
+
+    /**
+     *  @brief Index of the switch type that connects output pins (OPINs) *to* this segment 
+     *  from *another dice*. Note that this index is in relation to the switches from the 
+     *  architecture file, not the expanded list of switches that is built at the end of 
+     *  build_rr_graph.
+     */
+    short arch_inter_die_switch = 0;
+
+    /**
+     *  @brief Resistance of a routing track, per unit logic block length.
+     */
     float Rmetal = 0;
+
+    /**
+     *  @brief Capacitance of a routing track, per unit logic block length.
+     */
     float Cmetal = 0;
+
     bool twisted = false;
+
+    /**
+     *  @brief Direction of the segment.
+     */
     enum Direction direction = Direction::NONE;
+
+    /**
+     *  @brief Index of the first logic block in the group.
+     */
     int group_start = 0;
+
+    /**
+     *  @brief Size of the group.
+     */
     int group_size = 0;
+
+    /**
+     *  @brief Index of the first logic block in the segment.
+     */
     int seg_start = 0;
+
+    /**
+     *  @brief Index of the last logic block in the segment.
+     */
     int seg_end = 0;
+
+    /**
+     *  @brief index of the segment type used for this track.
+     *  Note that this index will store the index of the segment
+     *  relative to its **parallel** segment types, not all segments
+     *  as stored in device_ctx. Look in rr_graph.cpp: build_rr_graph
+     *  for details but here is an example: say our segment_inf_vec in
+     *  device_ctx is as follows: [seg_a_x, seg_b_x, seg_a_y, seg_b_y]
+     *  when building the rr_graph, static segment_inf_vectors will be
+     *  created for each direction, thus you will have the following
+     *  2 vectors: X_vec =[seg_a_x,seg_b_x] and Y_vec = [seg_a_y,seg_b_y].
+     *  As a result, e.g. seg_b_y::index == 1 (index in Y_vec)
+     *  and != 3 (index in device_ctx segment_inf_vec).
+     */
     int index = 0;
+
+    /**
+     *  @brief index is relative to the segment_inf vec as stored in device_ctx.
+     *  Note that the above vector is **unifies** both x-parallel and
+     *  y-parallel segments and is loaded up originally in read_xml_arch_file.cpp
+     */
     int abs_index = 0;
-    float Cmetal_per_m = 0; ///<Used for power
+
+    /**
+     *  @brief Used for power
+     */
+    float Cmetal_per_m = 0;
+
+    /**
+     *  @brief Name of the segment type.
+     */
     std::string type_name;
 };
 
@@ -1453,7 +1507,7 @@ class t_chan_seg_details {
 
     short arch_wire_switch() const { return seg_detail_->arch_wire_switch; }
     short arch_opin_switch() const { return seg_detail_->arch_opin_switch; }
-    short arch_opin_between_dice_switch() const { return seg_detail_->arch_opin_between_dice_switch; }
+    short arch_inter_die_switch() const { return seg_detail_->arch_inter_die_switch; }
 
     Direction direction() const { return seg_detail_->direction; }