Only remove top level Vivado bus prevention annotations (#1317)

* Only remove top level Vivado bus prevention annotations

Signed-off-by: Andrew Butt <[email protected]>

* Update src/com/xilinx/rapidwright/edif/EDIFCell.java

Co-authored-by: Chris Lavin <[email protected]>
Signed-off-by: Andrew Butt <[email protected]>

* Update javadoc

Signed-off-by: Andrew Butt <[email protected]>

---------

Signed-off-by: Andrew Butt <[email protected]>
Signed-off-by: Andrew Butt <[email protected]>
Co-authored-by: Chris Lavin <[email protected]>

Author: abutt-amd

src/com/xilinx/rapidwright/edif/EDIFCell.java

@@ -313,7 +313,7 @@ public EDIFPort getPort(String name) {
     /**
      * Given a port instance name (not including the name of the cell instance),
      * gets the associated port.
-     * 
+     *
      * @param portInstName
      * @return
      */
@@ -809,8 +809,10 @@ public boolean isUniquified() {
     }
 
     /**
-     * Checks if this cell and the provided cell have the same set of ports
-     * 
+     * Checks if this cell and the provided cell have the same set of ports.
+     * Port names that are the same except for starting with EDIFTools.VIVADO_PRESERVE_PORT_INTERFACE ("[]") are
+     * considered equivalent for the purpose of cells having a matching set of ports.
+     *
      * @param other The other cell to match against.
      * @return True if the set of ports on both this cell and the other cell match
      *         exactly. False otherwise.
@@ -822,6 +824,10 @@ public boolean matchesInterface(EDIFCell other) {
         Map<String, EDIFPort> otherPorts = other.getPortMap();
         for (EDIFPort port : getPorts()) {
             EDIFPort otherPort = otherPorts.get(port.getBusName(true));
+            if (otherPort == null) {
+                otherPort = otherPorts.get(EDIFTools.VIVADO_PRESERVE_PORT_INTERFACE
+                        + port.getBusName(true));
+            }
             if (otherPort == null || port.getWidth() != otherPort.getWidth()
                     || port.getDirection() != otherPort.getDirection()) {
                 return false;

src/com/xilinx/rapidwright/edif/EDIFTools.java

@@ -1783,18 +1783,25 @@ public static void ensurePreservedInterfaceVivado(EDIFNetlist netlist) {
         }
     }
 
+    /**
+     * Removes vivado bus prevention annotations from top-level ports. Vivado sometimes adds these annotations
+     * to prevent multiple single bit ports with similar names from getting merged into a single bus. The method
+     * used here will only work on the top-level cell as we do not traverse the netlist to ensure the new names
+     * are consistent.
+     *
+     * @param netlist  The netlist to remove bus prevention annotations from.
+     *
+     */
     public static void removeVivadoBusPreventionAnnotations(EDIFNetlist netlist) {
         EDIFCell top = netlist.getTopCell();
-        for (EDIFCell cell : netlist.getLibrary(top.getLibrary().getName()).getCells()) {
-            List<String> portsToRename = new ArrayList<>();
-            for (EDIFPort p : cell.getPorts()) {
-                if (p.getName().startsWith(VIVADO_PRESERVE_PORT_INTERFACE)) {
-                    portsToRename.add(p.getName());
-                }
-            }
-            for (String p : portsToRename) {
-                cell.renamePort(p, p.substring(VIVADO_PRESERVE_PORT_INTERFACE.length()));
+        List<String> portsToRename = new ArrayList<>();
+        for (EDIFPort p : top.getPorts()) {
+            if (p.getName().startsWith(VIVADO_PRESERVE_PORT_INTERFACE)) {
+                portsToRename.add(p.getName());
             }
         }
+        for (String p : portsToRename) {
+            top.renamePort(p, p.substring(VIVADO_PRESERVE_PORT_INTERFACE.length()));
+        }
     }
 }