Adding a test

Signed-off-by: Chris Lavin <[email protected]>

Author: clavin-xlnx

src/com/xilinx/rapidwright/design/tools/InlineFlopTools.java

@@ -39,6 +39,7 @@
 import com.xilinx.rapidwright.design.Unisim;
 import com.xilinx.rapidwright.design.blocks.PBlock;
 import com.xilinx.rapidwright.device.BEL;
+import com.xilinx.rapidwright.device.Series;
 import com.xilinx.rapidwright.device.Site;
 import com.xilinx.rapidwright.eco.ECOPlacementHelper;
 import com.xilinx.rapidwright.edif.EDIFCell;
@@ -63,21 +64,24 @@ public class InlineFlopTools {
     private static final String PBLOCK_OPT = "--pblock";
     private static final String REMOVE_FLOPS_OPT = "--remove_flops";
 
-    private static final String INLINE_SUFFIX = "_rw_inline_flop";
+    public static final String INLINE_SUFFIX = "_rw_inline_flop";
 
     /**
      * Add flip flops inline on all the top-level ports of an out-of-context design.
      * This is useful for placed out-of-context kernels prior to routing so that
      * after the flops have been placed, the router is forced to route connections
      * of each of the ports to each of the flops. This can help alleviate congestion
-     * when the kernels are placed/relocated in context.
+     * when the kernels are placed/relocated in context. Note this assumes the
+     * design is not implemented as in most contexts it will be placed and routed
+     * immediately following this modification.
      * 
      * @param design  The design to modify
      * @param clkNet  Name of the clock net to use on which to add the flops
      * @param keepOut The pblock used to contain the kernel and the added flops will
      *                not be placed inside this area.
      */
     public static void createAndPlaceFlopsInlineOnTopPorts(Design design, String clkNet, PBlock keepOut) {
+        assert (design.getSiteInsts().size() == 0);
         EDIFCell top = design.getTopEDIFCell();
         Site start = keepOut.getAllSites("SLICE").iterator().next(); // TODO this is a bit wasteful
         boolean exclude = true;
@@ -89,6 +93,10 @@ public static void createAndPlaceFlopsInlineOnTopPorts(Design design, String clk
         Set<SiteInst> siteInstsToRoute = new HashSet<>();
 
         for (EDIFPort port : top.getPorts()) {
+            // Don't flop the clock net
+            if (port.getName().equals(clkNet)) {
+                continue;
+            }
             if (port.isBus()) {
                 for (int i : port.getBitBlastedIndicies()) {
                     EDIFPortInst inst = port.getInternalPortInstFromIndex(i);
@@ -160,6 +168,7 @@ public static void removeInlineFlops(Design design) {
         Net vcc = design.getVccNet();
         Set<SitePinInst> vccPins = new HashSet<>();
         pinsToRemove.put(vcc, vccPins);
+        String[] staticPins = new String[] { "CKEN1", design.getSeries() == Series.Versal ? "RST" : "SRST1" };
         for (EDIFCellInst inst : design.getTopEDIFCell().getCellInsts()) {
             if (inst.getName().endsWith(INLINE_SUFFIX)) {
                 Cell flop = design.getCell(inst.getName());
@@ -169,8 +178,11 @@ public static void removeInlineFlops(Design design) {
                 for (SitePinInst pin : si.getSitePinInsts()) {
                     pinsToRemove.computeIfAbsent(pin.getNet(), p -> new HashSet<>()).add(pin);
                 }
-                vccPins.add(vcc.createPin("CKEN1", si));
-                vccPins.add(vcc.createPin("RST", si));
+                for (String staticPin : staticPins) {
+                    if (si.getSitePinInst(staticPin) == null) {
+                        vccPins.add(vcc.createPin(staticPin, si));
+                    }
+                }
 
                 cellsToRemove.add(inst);
             }
@@ -217,6 +229,7 @@ public static void removeInlineFlops(Design design) {
             }
 
             top.removeCellInst(c);
+            design.removeCell(c.getName());
         }
 
     }

src/com/xilinx/rapidwright/util/VivadoTools.java

@@ -388,6 +388,45 @@ public static ReportRouteStatusResult routeDesignAndGetStatus(Design design, Pat
         return routeDesignAndGetStatus(dcp, workdir, encrypted);
     }
 
+    /**
+     * Run Vivado's `place_design` and `route_design` command on the design provided
+     * and get the `report_route_status` results. Note: this method does not
+     * preserve the routed output from Vivado.
+     * 
+     * @param design  The design to route and report on.
+     * @param workdir Directory to work within.
+     * @return The results of `report_route_status`.
+     */
+    public static ReportRouteStatusResult placeAndRouteDesignAndGetStatus(Design design, Path workdir) {
+        boolean encrypted = !design.getNetlist().getEncryptedCells().isEmpty();
+        Path dcp = workdir.resolve("placeAndRouteDesignAndGetStatus.dcp");
+        design.writeCheckpoint(dcp);
+        return placeAndRouteDesignAndGetStatus(dcp, workdir, encrypted);
+    }
+
+    /**
+     * Run Vivado's `place_design` and `route_design` command on the provided DCP
+     * path and return the `report_route_status` results. Note: this method does not
+     * preserve the routed output from Vivado.
+     *
+     * @param dcp       Path to DCP to route and report on.
+     * @param workdir   Directory to work within.
+     * @param encrypted Indicates whether DCP contains encrypted EDIF cells.
+     * @return The results of `report_route_status`.
+     */
+    public static ReportRouteStatusResult placeAndRouteDesignAndGetStatus(Path dcp, Path workdir, boolean encrypted) {
+        final Path outputLog = workdir.resolve("outputLog.log");
+
+        StringBuilder sb = new StringBuilder();
+        sb.append(createTclDCPLoadCommand(dcp, encrypted));
+        sb.append(PLACE_DESIGN + "; ");
+        sb.append(ROUTE_DESIGN + "; ");
+        sb.append(REPORT_ROUTE_STATUS + "; ");
+
+        List<String> log = VivadoTools.runTcl(outputLog, sb.toString(), true);
+        return new ReportRouteStatusResult(log);
+    }
+
     /**
      * Run Vivado's `route_design` command on the provided DCP path and return the
      * `report_route_status` results. Note: this method does not preserve the routed

test/shared/com/xilinx/rapidwright/util/VivadoToolsHelper.java

@@ -60,4 +60,12 @@ public static void assertRoutedSuccessfullyByVivado(Design design, Path dir) {
         ReportRouteStatusResult rrs = VivadoTools.routeDesignAndGetStatus(design, dir);
         Assertions.assertTrue(rrs.isFullyRouted());
     }
+
+    public static void assertCanBeFullyPlacedAndRoutedByVivado(Design design, Path dir) {
+        if (!FileTools.isVivadoOnPath()) {
+            return;
+        }
+        ReportRouteStatusResult rrs = VivadoTools.placeAndRouteDesignAndGetStatus(design, dir);
+        Assertions.assertTrue(rrs.isFullyRouted());
+    }
 }