EDIFTools

Object
- com.xilinx.rapidwright.edif.EDIFTools

```
public class EDIFTools
extends Object
```
A collection of utility methods for extracting information from BYU EDIF tool netlists. Created on: Dec 2, 2015

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DONT_TOUCH`
`static String`	`EDIF_HIER_SEP`
`static String`	`EDIF_LIBRARY_HDI_PRIMITIVES_NAME`
`static String`	`EDIF_LIBRARY_WORK_NAME`
`static String`	`EDIF_PART_PROP`
`static Set<String>`	`edifKeywordSet`
`static String`	`LOAD_TCL_SUFFIX`
`static String`	`LOGICAL_GND_NET_NAME`
`static String`	`LOGICAL_VCC_NET_NAME`
`static String`	`MACRO_PRIMITIVES_LIB`
`static boolean`	`RW_ENABLE_EDIF_BINARY_CACHING` Flag to set a feature where any .edf file that is attempted to be loaded will check if an existing binary EDIF has already been generated and will load that instead (faster).
`static AtomicInteger`	`UNIQUE_COUNT`

Constructor Summary

Constructors
Constructor and Description

EDIFTools()

Constructors
Constructor and Description
`EDIFTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static EDIFPortInst`	`addDebugPort(EDIFNet net, EDIFCell topCell, EDIFPortInst currPort, EDIFCellInst debugCore)` Adds the debug port to the debug core in the EDIF netlist
`static EDIFNet`	`addDebugPortAndNet(String newDebugNetName, EDIFCell topCell, EDIFPortInst currPort, EDIFCellInst debugCore)` Specialized function to add enable a debug probe connection.
`static EDIFNet`	`addNet(EDIFNetlist e, String hierarchicalName)`
`static void`	`addTopLevelPort(Design d, String name, EDIFCellInst i, PinType dir)` Creates (or gets) a top level port by the specified name.
`static String[]`	`bitBlast(String bussedSignal)` Bit blasts the shorthand bus name (ex: `"data[0:2]" --> ["data0", "data1", "data2"]`)
`static int[]`	`bitBlastBus(String busSuffix)`
`static void`	`connectDebugProbe(EDIFNet topPortNet, String routedNetName, String newPortName, EDIFHierCellInst parentInst, EDIFNetlist netlist, HashMap<EDIFCell,ArrayList<EDIFCellInst>> instMap)` Specialized function to connect a debug port within an EDIF netlist.
`static void`	`connectPortBus(EDIFCell topCell, EDIFCellInst src, EDIFCellInst snk, String srcPrefix, String snkPrefix, int width)`
`static void`	`connectPortInstsThruHier(EDIFHierNet net, EDIFHierPortInst pin, String newName)` Connects an existing logical net and logical port inst together by creating new ports and nets on all cells instantiated between their levels of hierarchy.
`static void`	`connectPortInstsThruHier(EDIFHierPortInst src, EDIFHierPortInst snk, String newName)` Connects two existing logical port insts together by creating new ports and nets on all cells instantiated between their levels of hierarchy.
`static void`	`consolidateLibraries(EDIFNetlist edif)`
`static Map<EDIFLibrary,Map<EDIFCell,List<EDIFHierCellInst>>>`	`createCellInstanceMap(EDIFNetlist netlist)` Creates a map of all cells in the netlist and a mapping to a list of all the hierarchical instances of that cell.
`static EDIFNetlist`	`createFlatNetlist(EDIFNetlist netlist, String partName)` Creates a flattened version of the provided netlist.
`static EDIFNetlist`	`createNewNetlist(EDIFCellInst cellInst)` Creates a new netlist from an existing EDIFCellInst in a netlist.
`static EDIFNetlist`	`createNewNetlist(String topName)`
`static EDIFNetlist`	`createNewNetlist(String topName, boolean addINV)`
`static EDIFPortInst[]`	`createPortInsts(EDIFCell parent, String name, EDIFDirection dir, int width)` Creates a top level port (if it doesn't already exist) and an array of corresponding `EDIFPortInst`s to be used to connect to an array of EDIFNets
`static EDIFPortInst[]`	`createPortInsts(String name, EDIFDirection dir, int width, EDIFCellInst eci)` Creates an array of `EDIFPortInst`s from an existing port on an `EDIFCellInst`.
`static EDIFPortInst`	`createTopLevelPortInst(Design d, String name, PinType dir)` Creates (or gets if it already exists) a top level port instance.
`static EDIFNet`	`createUniqueNet(EDIFCell parentCell, String netName)` Create a unique net in the provided parent EDIFCell with the preferred provided name.
`static EDIFPort`	`createUniquePort(EDIFCell parentCell, String portName, EDIFDirection dir, int width)` Create a unique port in the provided parent EDIFCell with the preferred provided name.
`static boolean`	`ensureCellInLibraries(EDIFNetlist e, EDIFCell c)`
`static void`	`ensureCorrectPartInEDIF(EDIFNetlist edif, String partName)`
`static ArrayList<EDIFHierPortInst>`	`findSinks(EDIFHierPortInst startingInput)` Traverse all connected EDIFNets to find all leaf sink portrefs as part of the physical net.
`static HashMap<EDIFCell,ArrayList<EDIFCellInst>>`	`generateCellInstMap(EDIFCellInst topCellInst)` Creates a map for each EDIF cell type to all its instances, starting with the top cell instance.
`static Path`	`getEDIFParentDir(Path edifFileName)`
`static List<String>`	`getEDNFiles(Path parent)`
`static List<String>`	`getMacroLeafCellNames(EDIFCell cell)`
`static EDIFNet`	`getNet(EDIFNetlist e, String hierarchicalName)` Gets the EDIFNet corresponding to the hierarchical name of a net.
`static String`	`getPartName(EDIFNetlist edif)` Helper method to get the part name from an EDIF netlist.
`static int`	`getPortIndexFromName(String name)`
`static String`	`getRootBusName(String name)` Strips off bracket index in a bussed name (ex: `"data[0]" --> "data["`).
`static String`	`getRootBusName(String name, boolean includeOpenBracket)` Strips off bracket index in a bussed name (ex: `"data[0]" --> "data"`).
`static EDIFNet`	`getStaticNet(NetType type, EDIFCell cell, EDIFNetlist netlist)` Creates and/or gets the static net (GND/VCC) in the specified cell.
`static EDIFNet`	`getStaticNet(NetType type, EDIFCell cell, EDIFNetlist netlist, String netName)` Creates and/or gets the static net (GND/VCC) in the specified cell.
`static EDIFHierNet`	`getStaticNet(NetType type, EDIFHierCellInst cellInst, EDIFNetlist netlist)` Creates and/or gets the static net (GND/VCC) in the specified cell.
`static String`	`getUniqueSuffix()`
`static int`	`getWidthOfPortFromName(String name)`
`static int`	`lengthOfNameWithoutBus(char[] name)` Determines if the char[] ends with the pattern [#:#] where # are positive bus values (e.g., [7:0]) and then returns the length of the string without the bus suffix (if it exists).
`static int`	`lengthOfNameWithoutBus(char[] name, boolean keepOpenBracket)` Determines if the char[] ends with the pattern [#:#] where # are positive bus values (e.g., [7:0]) and then returns the length of the string without the bus suffix (if it exists).
`static EDIFNetlist`	`loadEDIFFile(Path fileName)`
`static EDIFNetlist`	`loadEDIFFile(Path fileName, int maxThreads)`
`static EDIFNetlist`	`loadEDIFFile(String fileName)`
`static EDIFNetlist`	`loadEDIFStream(InputStream is, long size)`
`static void`	`lockNetlist(EDIFNetlist netlist)` Locks the netlist by applying the DONT_TOUCH property to instances and nets so that Vivado won't make changes to it during opt_design, place_design, phys_opt_design, or route_design.
`static void`	`main(String[] args)`
`static String`	`makeNameEDIFCompatible(String currName)` Tries to make a string EDIF compatible by replacing invalid characters with an underscore.
`static void`	`printHierSepNames(EDIFNetlist netlist)`
`static void`	`printLibraries(EDIFNetlist netlist)`
`static EDIFNetlist`	`readEdifFile(Path edifFileName)`
`static EDIFNetlist`	`readEdifFile(Path edifFileName, int maxThreads)`
`static EDIFNetlist`	`readEdifFile(String edifFileName)`
`static EDIFNetlist`	`readEdifFromZipFile(String zipFileName)`
`static <T extends EDIFName> Iterable<T>`	`sortIfStable(Collection<T> collection, boolean stable)`
`static <T> Iterable<T>`	`sortIfStable(Collection<T> collection, Comparator<T> comparator, boolean stable)`
`static <T extends Comparable<T>,U> Iterable<Map.Entry<T,U>>`	`sortIfStable(Map<T,U> collection, boolean stable)`
`static Boolean`	`uniqueifyNetlist(Design design)` Duplicates EDIFCells such that each EDIFCellInst only instantiates an EDIFCell once (except primitives and macros).
`static void`	`unlockNetlist(EDIFNetlist netlist)` Unlocks the netlist by removing the DONT_TOUCH property on instances and nets so that Vivado won't make changes to it during opt_design, place_design, phys_opt_design, or route_design.
`static void`	`writeEDIFFile(OutputStream out, EDIFNetlist edif, String partName)`
`static void`	`writeEDIFFile(OutputStream out, Path dcpFileName, EDIFNetlist edif, String partName)` Write out EDIF to a stream.
`static void`	`writeEDIFFile(OutputStream out, String dcpFileName, EDIFNetlist edif, String partName)` Write out EDIF to a stream.
`static void`	`writeEDIFFile(Path fileName, EDIFNetlist edif, String partName)`
`static void`	`writeEDIFFile(String fileName, EDIFNetlist edif, String partName)`
`static void`	`writeTclLoadScriptForPartialEncryptedDesigns(EDIFNetlist edif, Path dcpFileName, String partName)`

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EDIF_HIER_SEP
```
public static String EDIF_HIER_SEP
```
  - EDIF_LIBRARY_HDI_PRIMITIVES_NAME
```
public static final String EDIF_LIBRARY_HDI_PRIMITIVES_NAME
```
    See Also:
    
    Constant Field Values
  - MACRO_PRIMITIVES_LIB
```
public static final String MACRO_PRIMITIVES_LIB
```
    See Also:
    
    Constant Field Values
  - EDIF_LIBRARY_WORK_NAME
```
public static final String EDIF_LIBRARY_WORK_NAME
```
    See Also:
    
    Constant Field Values
  - EDIF_PART_PROP
```
public static final String EDIF_PART_PROP
```
    See Also:
    
    Constant Field Values
  - DONT_TOUCH
```
public static final String DONT_TOUCH
```
    See Also:
    
    Constant Field Values
  - edifKeywordSet
```
public static final Set<String> edifKeywordSet
```
  - LOGICAL_VCC_NET_NAME
```
public static final String LOGICAL_VCC_NET_NAME
```
    See Also:
    
    Constant Field Values
  - LOGICAL_GND_NET_NAME
```
public static final String LOGICAL_GND_NET_NAME
```
    See Also:
    
    Constant Field Values
  - LOAD_TCL_SUFFIX
```
public static final String LOAD_TCL_SUFFIX
```
    See Also:
    
    Constant Field Values
  - UNIQUE_COUNT
```
public static final AtomicInteger UNIQUE_COUNT
```
  - RW_ENABLE_EDIF_BINARY_CACHING
```
public static final boolean RW_ENABLE_EDIF_BINARY_CACHING
```
    Flag to set a feature where any .edf file that is attempted to be loaded will check if an existing binary EDIF has already been generated and will load that instead (faster). This will also enable generation of binary EDIF files after a successful EDIF file loading to be used on the next load.
- Constructor Detail
  - EDIFTools
```
public EDIFTools()
```
- Method Detail
  - getUniqueSuffix
```
public static String getUniqueSuffix()
```
  - getPartName
```
public static String getPartName(EDIFNetlist edif)
```
    Helper method to get the part name from an EDIF netlist.
    
    Parameters:
    
    edif - The EDIF netlist from which to extract the part name.
    
    Returns:
    
    The part name or null if none was found.
  - ensureCellInLibraries
```
public static boolean ensureCellInLibraries(EDIFNetlist e,
                                            EDIFCell c)
```
  - consolidateLibraries
```
public static void consolidateLibraries(EDIFNetlist edif)
```
  - connectPortBus
```
public static void connectPortBus(EDIFCell topCell,
                                  EDIFCellInst src,
                                  EDIFCellInst snk,
                                  String srcPrefix,
                                  String snkPrefix,
                                  int width)
```
  - generateCellInstMap
```
public static HashMap<EDIFCell,ArrayList<EDIFCellInst>> generateCellInstMap(EDIFCellInst topCellInst)
```
    Creates a map for each EDIF cell type to all its instances, starting with the top cell instance.
    
    Parameters:
    
    topCellInst - The top cell instance from which to start the search.
    
    Returns:
    
    A map where the key is the cell type and the value is a list of all instances of the type.
  - getNet
```
public static EDIFNet getNet(EDIFNetlist e,
                             String hierarchicalName)
```
    Gets the EDIFNet corresponding to the hierarchical name of a net.
    
    Parameters:
    
    hierarchicalName - The full path name to the het
    
    Returns:
    
    The net or null if none was found
  - addNet
```
public static EDIFNet addNet(EDIFNetlist e,
                             String hierarchicalName)
```
  - makeNameEDIFCompatible
```
public static String makeNameEDIFCompatible(String currName)
```
    Tries to make a string EDIF compatible by replacing invalid characters with an underscore.
    
    Parameters:
    
    currName - Existing name to be made legal
    
    Returns:
    
    A new string that has been legalized to EDIF standards.
  - getRootBusName
```
public static String getRootBusName(String name)
```
    Strips off bracket index in a bussed name (ex: "data[0]" --> "data["). Leaves open bracket by default as this is the key for bussed ports in the port map of EDIFCell
    
    Parameters:
    
    name - Bracketed bussed name.
    
    Returns:
    
    Name of bus with index and close bracket removed
  - getRootBusName
```
public static String getRootBusName(String name,
                                    boolean includeOpenBracket)
```
    Strips off bracket index in a bussed name (ex: "data[0]" --> "data").
    
    Parameters:
    
    name - Bracketed bussed name.
    
    includeOpenBracket - If true, the result will include the open square bracket ("data[")
    
    Returns:
    
    Name of bus with brackets removed
  - lengthOfNameWithoutBus
```
public static int lengthOfNameWithoutBus(char[] name)
```
    Determines if the char[] ends with the pattern [#:#] where # are positive bus values (e.g., [7:0]) and then returns the length of the string without the bus suffix (if it exists). If the name does not end with the bus pattern, it returns the original length of the char[].
    
    Parameters:
    
    name -
    
    Returns:
    
    The length of the string
  - lengthOfNameWithoutBus
```
public static int lengthOfNameWithoutBus(char[] name,
                                         boolean keepOpenBracket)
```
    Determines if the char[] ends with the pattern [#:#] where # are positive bus values (e.g., [7:0]) and then returns the length of the string without the bus suffix (if it exists). If the name does not end with the bus pattern, it returns the original length of the char[].
    
    Parameters:
    
    name -
    
    keepOpenBracket - In the case of a bussed name, this will return the index of the string including the open square bracket (useful for port the bus name keyed map in EDIFCell).
    
    Returns:
    
    The length of the string
  - getPortIndexFromName
```
public static int getPortIndexFromName(String name)
```
  - getWidthOfPortFromName
```
public static int getWidthOfPortFromName(String name)
```
    Parameters:
    
    name -
    
    Returns:
  - createUniqueNet
```
public static EDIFNet createUniqueNet(EDIFCell parentCell,
                                      String netName)
```
    Create a unique net in the provided parent EDIFCell with the preferred provided name. If such a net already exists in this cell, append a unique suffix.
    
    Parameters:
    
    parentCell - EDIFCell in which new net is to be created.
    
    netName - Preferred net name.
    
    Returns:
    
    Newly created EDIFNet.
  - createUniquePort
```
public static EDIFPort createUniquePort(EDIFCell parentCell,
                                        String portName,
                                        EDIFDirection dir,
                                        int width)
```
    Create a unique port in the provided parent EDIFCell with the preferred provided name. If such a port already exists in this cell, append a unique suffix. This method checks for the existence of the given name as well as for its root bus, e.g. for portName 'foo[9]', both this exact name and 'foo' will be checked.
    
    Parameters:
    
    parentCell - EDIFCell in which new port is to be created.
    
    portName - Preferred port name.
    
    dir - EDIFDirection.
    
    width - Bit width.
    
    Returns:
    
    Newly created EDIFPort.
  - connectPortInstsThruHier
```
public static void connectPortInstsThruHier(EDIFHierPortInst src,
                                            EDIFHierPortInst snk,
                                            String newName)
```
    Connects two existing logical port insts together by creating new ports and nets on all cells instantiated between their levels of hierarchy. It assumes the netlist cells involved only have one instance (does not differentiate cells when creating the ports). This assumption can be enforced by calling EDIFTools.uniqueifyNetlist(Design). If the src or snk port insts do net have nets connected, it will create them and connect them in their parent cell definition.
    
    Parameters:
    
    src - The logical port inst driver or source
    
    snk - The logical port inst sink
    
    newName - A unique name to be used in creating the ports and nets
  - connectPortInstsThruHier
```
public static void connectPortInstsThruHier(EDIFHierNet net,
                                            EDIFHierPortInst pin,
                                            String newName)
```
    Connects an existing logical net and logical port inst together by creating new ports and nets on all cells instantiated between their levels of hierarchy. This is a helper method on top of EDIFTools.connectPortInstsThruHier(EDIFHierPortInst,EDIFHierPortInst,String) for identifying the correct source and sink pins to be provided to this, according to whether the provided pin argument is an input or output pin (and finding the appropriate pin from the provided net).
    
    Parameters:
    
    net - The logical net
    
    pin - The logical port inst source or sink
    
    newName - A unique name to be used in creating the ports and nets
  - connectDebugProbe
```
public static void connectDebugProbe(EDIFNet topPortNet,
                                     String routedNetName,
                                     String newPortName,
                                     EDIFHierCellInst parentInst,
                                     EDIFNetlist netlist,
                                     HashMap<EDIFCell,ArrayList<EDIFCellInst>> instMap)
```
    Specialized function to connect a debug port within an EDIF netlist.
    
    Parameters:
    
    topPortNet - The top-level net that connects to the debug core's input port.
    
    routedNetName - The name of the routed net who's source is the net we need to connect to
    
    newPortName - The name of the port to be added at each level of hierarchy
    
    parentInst - The instance where topPortNet resides
    
    netlist - The current netlist
    
    instMap - The map of the design created by EDIFTools.generateCellInstMap(EDIFCellInst)
  - addDebugPortAndNet
```
public static EDIFNet addDebugPortAndNet(String newDebugNetName,
                                         EDIFCell topCell,
                                         EDIFPortInst currPort,
                                         EDIFCellInst debugCore)
```
    Specialized function to add enable a debug probe connection. Adds the external port on the debug core and a new net at the top level that can be used to as a sink to probe a user signal. Used in conjunction with EDIFTools.connectDebugProbe(...)
    
    Parameters:
    
    newDebugNetName - Name of the debug net to add at the top level
    
    topCell - Name of the cell where the net and port should exists
    
    currPort - The existing port on the debug core
    
    debugCore - The instance of the debug core already within the EDIF design
    
    Returns:
    
    The newly created net with the debug port attached.
  - addDebugPort
```
public static EDIFPortInst addDebugPort(EDIFNet net,
                                        EDIFCell topCell,
                                        EDIFPortInst currPort,
                                        EDIFCellInst debugCore)
```
    Adds the debug port to the debug core in the EDIF netlist
    
    Parameters:
    
    net - The net to which the port should connect
    
    topCell - The top cell which has the debug core as a subcell
    
    currPort - The current port to add
    
    debugCore - The debug core
    
    Returns:
    
    The newly created EDIFPortInst
  - getStaticNet
```
public static EDIFHierNet getStaticNet(NetType type,
                                       EDIFHierCellInst cellInst,
                                       EDIFNetlist netlist)
```
    Creates and/or gets the static net (GND/VCC) in the specified cell.
    
    Parameters:
    
    type - The type of net to get or create
    
    cellInst - The hier cell inst that should have a static net
    
    netlist - The netlist of interest
    
    Returns:
    
    An existing or newly created static hier net for the cell provided.
  - getStaticNet
```
public static EDIFNet getStaticNet(NetType type,
                                   EDIFCell cell,
                                   EDIFNetlist netlist)
```
    Creates and/or gets the static net (GND/VCC) in the specified cell.
    
    Parameters:
    
    type - The type of net to get or create
    
    cell - The cell that should have a static net
    
    netlist - The netlist of interest
    
    Returns:
    
    An existing or newly created static net for the cell provided.
  - getStaticNet
```
public static EDIFNet getStaticNet(NetType type,
                                   EDIFCell cell,
                                   EDIFNetlist netlist,
                                   String netName)
```
    Creates and/or gets the static net (GND/VCC) in the specified cell.
    
    Parameters:
    
    type - The type of net to get or create
    
    cell - The cell that should have a static net
    
    netlist - The netlist of interest
    
    netName - If the net is to be created, what is the desired name
    
    Returns:
    
    An existing or newly created static net for the cell provided.
  - main
```
public static void main(String[] args)
```
  - loadEDIFStream
```
public static EDIFNetlist loadEDIFStream(InputStream is,
                                         long size)
                                  throws IOException
```
    Throws:
    
    IOException
  - loadEDIFFile
```
public static EDIFNetlist loadEDIFFile(Path fileName)
```
  - loadEDIFFile
```
public static EDIFNetlist loadEDIFFile(Path fileName,
                                       int maxThreads)
```
  - loadEDIFFile
```
public static EDIFNetlist loadEDIFFile(String fileName)
```
  - ensureCorrectPartInEDIF
```
public static void ensureCorrectPartInEDIF(EDIFNetlist edif,
                                           String partName)
```
  - readEdifFile
```
public static EDIFNetlist readEdifFile(Path edifFileName)
```
  - getEDNFiles
```
public static List<String> getEDNFiles(Path parent)
```
  - getEDIFParentDir
```
public static Path getEDIFParentDir(Path edifFileName)
```
  - readEdifFile
```
public static EDIFNetlist readEdifFile(Path edifFileName,
                                       int maxThreads)
```
  - readEdifFile
```
public static EDIFNetlist readEdifFile(String edifFileName)
```
  - writeEDIFFile
```
public static void writeEDIFFile(Path fileName,
                                 EDIFNetlist edif,
                                 String partName)
```
  - writeEDIFFile
```
public static void writeEDIFFile(String fileName,
                                 EDIFNetlist edif,
                                 String partName)
```
  - writeEDIFFile
```
public static void writeEDIFFile(OutputStream out,
                                 EDIFNetlist edif,
                                 String partName)
```
  - writeEDIFFile
```
public static void writeEDIFFile(OutputStream out,
                                 Path dcpFileName,
                                 EDIFNetlist edif,
                                 String partName)
```
    Write out EDIF to a stream. Also checks if netlist has potential encrypted cells and creates a Tcl script to help re-import design into Vivado intact.
    
    Parameters:
    
    out - The output stream
    
    dcpFileName - The name of the DCP file associated with this netlist
    
    edif - The netlist of the design
    
    partName - The target part for this design
  - writeEDIFFile
```
public static void writeEDIFFile(OutputStream out,
                                 String dcpFileName,
                                 EDIFNetlist edif,
                                 String partName)
```
    Write out EDIF to a stream. Also checks if netlist has potential encrypted cells and creates a Tcl script to help re-import design into Vivado intact.
    
    Parameters:
    
    out - The output stream
    
    dcpFileName - The name of the DCP file associated with this netlist
    
    edif - The netlist of the design
    
    partName - The target part for this design
  - writeTclLoadScriptForPartialEncryptedDesigns
```
public static void writeTclLoadScriptForPartialEncryptedDesigns(EDIFNetlist edif,
                                                                Path dcpFileName,
                                                                String partName)
```
  - readEdifFromZipFile
```
public static EDIFNetlist readEdifFromZipFile(String zipFileName)
                                       throws IOException
```
    Throws:
    
    IOException
  - createNewNetlist
```
public static EDIFNetlist createNewNetlist(String topName)
```
  - createNewNetlist
```
public static EDIFNetlist createNewNetlist(String topName,
                                           boolean addINV)
```
  - createNewNetlist
```
public static EDIFNetlist createNewNetlist(EDIFCellInst cellInst)
```
    Creates a new netlist from an existing EDIFCellInst in a netlist. This operation does not modify the source netlist.
    
    Parameters:
    
    cellInst - The new top cell/top cell inst in the netlist.
    
    Returns:
    
    The newly created netlist from the provided cell inst.
  - bitBlastBus
```
public static int[] bitBlastBus(String busSuffix)
```
  - bitBlast
```
public static String[] bitBlast(String bussedSignal)
```
    Bit blasts the shorthand bus name (ex: "data[0:2]" --> ["data0", "data1", "data2"])
    
    Parameters:
    
    bussedSignal - The bussed name with bracketed indices
    
    Returns:
    
    A fully expanded array of strings names or the original name if no brackets are present
  - createPortInsts
```
public static EDIFPortInst[] createPortInsts(EDIFCell parent,
                                             String name,
                                             EDIFDirection dir,
                                             int width)
```
    Creates a top level port (if it doesn't already exist) and an array of corresponding EDIFPortInsts to be used to connect to an array of EDIFNets
    
    Parameters:
    
    parent - Top level cell to which the port should be created
    
    name - Root name of the port to create and corresponding EDIFPortInsts (no brackets)
    
    dir - Direction of the port.
    
    width - Width of the port
    
    Returns:
    
    An array [0:width-1] of port refs.
  - createPortInsts
```
public static EDIFPortInst[] createPortInsts(String name,
                                             EDIFDirection dir,
                                             int width,
                                             EDIFCellInst eci)
```
    Creates an array of EDIFPortInsts from an existing port on an EDIFCellInst.
    
    Parameters:
    
    name - Root name of the port (no brackets)
    
    dir - Direction of the port
    
    width - Width of the port
    
    eci - The existing cell instance with the port to create the EDIFPortInsts.
    
    Returns:
    
    The newly created array of EDIFPortInsts corresponding the port and EDIFCellInst.
  - findSinks
```
public static ArrayList<EDIFHierPortInst> findSinks(EDIFHierPortInst startingInput)
```
    Traverse all connected EDIFNets to find all leaf sink portrefs as part of the physical net.
    
    Parameters:
    
    startingInput - Search begins at this portref and searches below in inner levels of hierarchy. Doesn't search backwards.
    
    Returns:
    
    The list of all leaf cell pin (portrefs) found below the provided starting input pin. Or null if the portref provided is not an input.
  - createTopLevelPortInst
```
public static EDIFPortInst createTopLevelPortInst(Design d,
                                                  String name,
                                                  PinType dir)
```
    Creates (or gets if it already exists) a top level port instance.
    
    Parameters:
    
    d - Current design with the netlist
    
    name - Name of the top level port
    
    dir - The desired port directionality
    
    Returns:
    
    The top level port instance (created or retrieved) from the top cell.
  - addTopLevelPort
```
public static void addTopLevelPort(Design d,
                                   String name,
                                   EDIFCellInst i,
                                   PinType dir)
```
    Creates (or gets) a top level port by the specified name. It will also ensure that the port is connected to the specified EDIFCellInst which should be part of an IBUF or OBUF.
    
    Parameters:
    
    d - Current design with netlist
    
    name - Name of the port (and net if none exists)
    
    i - IBUF (or INBUF in UltraScale devices) or OBUF instances
    
    dir - Direction of the pin on the IBUF/INBUF/OBUF instance to connect.
  - getMacroLeafCellNames
```
public static List<String> getMacroLeafCellNames(EDIFCell cell)
```
  - createCellInstanceMap
```
public static Map<EDIFLibrary,Map<EDIFCell,List<EDIFHierCellInst>>> createCellInstanceMap(EDIFNetlist netlist)
```
    Creates a map of all cells in the netlist and a mapping to a list of all the hierarchical instances of that cell. Helpful in finding multiple instances of the same cell.
    
    Parameters:
    
    netlist - The netlist to build the map from.
    
    Returns:
    
    The populated map of cells to list of hierarchical instances.
  - uniqueifyNetlist
```
public static Boolean uniqueifyNetlist(Design design)
```
    Duplicates EDIFCells such that each EDIFCellInst only instantiates an EDIFCell once (except primitives and macros). It also updates references throughout the logical and physical netlist so all references are self-consistent. This transformation is useful when performing netlist manipulations such as adding/removing cells, ports or nets within a design.
    
    Parameters:
    
    design - The design containing the netlist to uniqueify.
    
    Returns:
    
    True if uniqueification necessary and netlist was modified, False if not necessary and netlist was not modified. Null if indeterminable.
  - printHierSepNames
```
public static void printHierSepNames(EDIFNetlist netlist)
```
  - printLibraries
```
public static void printLibraries(EDIFNetlist netlist)
```
  - sortIfStable
```
public static <T> Iterable<T> sortIfStable(Collection<T> collection,
                                           Comparator<T> comparator,
                                           boolean stable)
```
  - sortIfStable
```
public static <T extends EDIFName> Iterable<T> sortIfStable(Collection<T> collection,
                                                            boolean stable)
```
  - sortIfStable
```
public static <T extends Comparable<T>,U> Iterable<Map.Entry<T,U>> sortIfStable(Map<T,U> collection,
                                                                                boolean stable)
```
  - lockNetlist
```
public static void lockNetlist(EDIFNetlist netlist)
```
    Locks the netlist by applying the DONT_TOUCH property to instances and nets so that Vivado won't make changes to it during opt_design, place_design, phys_opt_design, or route_design. Note: RapidWright doesn't respect the DONT_TOUCH attribute.
    
    Parameters:
    
    netlist - The netlist to lock
  - unlockNetlist
```
public static void unlockNetlist(EDIFNetlist netlist)
```
    Unlocks the netlist by removing the DONT_TOUCH property on instances and nets so that Vivado won't make changes to it during opt_design, place_design, phys_opt_design, or route_design.
    
    Parameters:
    
    netlist - The netlist to unlock
  - createFlatNetlist
```
public static EDIFNetlist createFlatNetlist(EDIFNetlist netlist,
                                            String partName)
```
    Creates a flattened version of the provided netlist.
    
    Parameters:
    
    netlist - The netlist to flatten.
    
    partName - The target part of the netlist.
    
    Returns:
    
    A new flattened version of the provided netlist.

Class EDIFTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

EDIF_HIER_SEP

EDIF_LIBRARY_HDI_PRIMITIVES_NAME

MACRO_PRIMITIVES_LIB

EDIF_LIBRARY_WORK_NAME

EDIF_PART_PROP

DONT_TOUCH

edifKeywordSet

LOGICAL_VCC_NET_NAME

LOGICAL_GND_NET_NAME

LOAD_TCL_SUFFIX

UNIQUE_COUNT

RW_ENABLE_EDIF_BINARY_CACHING

Constructor Detail

EDIFTools

Method Detail

getUniqueSuffix

getPartName

ensureCellInLibraries

consolidateLibraries

connectPortBus

generateCellInstMap

getNet

addNet

makeNameEDIFCompatible

getRootBusName

getRootBusName

lengthOfNameWithoutBus

lengthOfNameWithoutBus

getPortIndexFromName

getWidthOfPortFromName

createUniqueNet

createUniquePort

connectPortInstsThruHier

connectPortInstsThruHier

connectDebugProbe

addDebugPortAndNet

addDebugPort

getStaticNet

getStaticNet

getStaticNet

main

loadEDIFStream

loadEDIFFile

loadEDIFFile

loadEDIFFile

ensureCorrectPartInEDIF

readEdifFile

getEDNFiles

getEDIFParentDir

readEdifFile

readEdifFile

writeEDIFFile

writeEDIFFile

writeEDIFFile

writeEDIFFile

writeEDIFFile

writeTclLoadScriptForPartialEncryptedDesigns

readEdifFromZipFile

createNewNetlist

createNewNetlist

createNewNetlist

bitBlastBus

bitBlast

createPortInsts

createPortInsts

findSinks

createTopLevelPortInst

addTopLevelPort

getMacroLeafCellNames

createCellInstanceMap

uniqueifyNetlist

printHierSepNames

printLibraries

sortIfStable