com.xilinx.rapidwright.edif

Class EDIFPort

Object

com.xilinx.rapidwright.edif.EDIFName

com.xilinx.rapidwright.edif.EDIFPropertyObject

com.xilinx.rapidwright.edif.EDIFPort

All Implemented Interfaces:

Comparable<EDIFName>

public class EDIFPort
extends EDIFPropertyObject

Represents a port on an EDIFCell within an EDIF netlist. Created on: May 11, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	EXPORT_CONST_ARRAY_BEGIN
static byte[]	EXPORT_CONST_CHILD_INDENT
static byte[]	EXPORT_CONST_DIRECTION_START
static byte[]	EXPORT_CONST_INDENT
static byte[]	EXPORT_CONST_PORT_BEGIN

Fields inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject

EXPORT_CONST_OWNER_END, EXPORT_CONST_OWNER_START, EXPORT_CONST_PROP_END, EXPORT_CONST_PROP_START

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName

EXPORT_CONST_RENAME_START

Constructor Summary

Constructors

Constructor and Description
EDIFPort(EDIFPort port) Copy Constructor
EDIFPort(String name, EDIFDirection direction, int width)

Method Summary

Modifier and Type	Method and Description
void	exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache, boolean stable)
void	exportEDIFBusName(OutputStream os, EDIFWriteLegalNameCache<?> cache) Writes out valid EDIF syntax the name and/or rename of this port to the provided output writer.
int[]	getBitBlastedIndicies()
String	getBusName()
String	getBusName(boolean keepOpenBracket)
EDIFDirection	getDirection()
EDIFNet	getInternalNet() If the port is only one bit wide or the user only needs the 0th indexed net, this is a convenience method to getting the internal net (inside the cell) connected to this port.
EDIFNet	getInternalNet(int index) Gets the internal net connected to this port at specified index of the port, connected to the inside of the cell.
List<EDIFNet>	getInternalNets() Gets the list of internal nets connected to this port, indexed in the same way as the port.
Integer	getLeft()
EDIFCell	getParentCell()
int	getPortIndexFromNameIndex(int namedIndex) Gets the internal port instance index from the named index for this port.
String	getPortInstNameFromPort(int index) Gets the PortInst name from this port and the specified index
Integer	getRight()
int	getWidth()
boolean	isBus()
boolean	isBusRangeEqual(EDIFPort otherPort)
boolean	isInput()
boolean	isLittleEndian() If this port is a bus, it describes the endian-ness of how the bits in the bus vector are arranged.
boolean	isOutput()
void	setDirection(EDIFDirection direction)
void	setParentCell(EDIFCell parentCell)
void	setWidth(int width)

Methods inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject

addProperty, addProperty, addProperty, addProperty, addProperty, createDuplicatePropertiesMap, exportEDIFProperties, getIOStandard, getPropertiesMap, getProperty, removeProperty, setPropertiesMap

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName

compareTo, equals, exportEDIFName, exportSomeEDIFName, getName, getNewMap, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPORT_CONST_PORT_BEGIN

public static final byte[] EXPORT_CONST_PORT_BEGIN

EXPORT_CONST_ARRAY_BEGIN

public static final byte[] EXPORT_CONST_ARRAY_BEGIN

EXPORT_CONST_DIRECTION_START

public static final byte[] EXPORT_CONST_DIRECTION_START

EXPORT_CONST_INDENT

public static final byte[] EXPORT_CONST_INDENT

EXPORT_CONST_CHILD_INDENT

public static final byte[] EXPORT_CONST_CHILD_INDENT

Constructor Detail

EDIFPort

public EDIFPort(String name,
                EDIFDirection direction,
                int width)

EDIFPort

public EDIFPort(EDIFPort port)

Copy Constructor

Parameters:

port -

Method Detail

getDirection

public EDIFDirection getDirection()

Returns:

the direction

isLittleEndian

public boolean isLittleEndian()

If this port is a bus, it describes the endian-ness of how the bits in the bus vector are arranged. If the bus is little endian, LSB (least significant bit) is the rightmost bit (bus[7:0]). If the bus is not little endian (big endian), LSB is the left most bit (bus[0:7]).

Returns:

True if this bus is little endian, false otherwise. Not applicable for single bit ports.

isOutput

public boolean isOutput()

isInput

public boolean isInput()

setDirection

public void setDirection(EDIFDirection direction)

Parameters:

direction - the direction to set

getWidth

public int getWidth()

Returns:

the width

setWidth

public void setWidth(int width)

Parameters:

width - the width to set

getBusName

public String getBusName()

getBusName

public String getBusName(boolean keepOpenBracket)

getLeft

public Integer getLeft()

getRight

public Integer getRight()

getInternalNets

public List<EDIFNet> getInternalNets()

Gets the list of internal nets connected to this port, indexed in the same way as the port. A single bit port will only have one entry in the list, for example.

Returns:

The list of internal nets connected to this port. If one or more bits is not connected (such as in a primitive cell), a null entry will be present at the corresponding index.

getInternalNet

public EDIFNet getInternalNet(int index)

Gets the internal net connected to this port at specified index of the port, connected to the inside of the cell.

Parameters:

index - Index of port (0 if it is a single bit)

Returns:

The internal net connect to this port or null if not connect (such as a primitive).

getInternalNet

public EDIFNet getInternalNet()

If the port is only one bit wide or the user only needs the 0th indexed net, this is a convenience method to getting the internal net (inside the cell) connected to this port.

Returns:

The internal net connected to this port (single bit or 0th index only), or null if not connected (such as a primitive).

getPortInstNameFromPort

public String getPortInstNameFromPort(int index)

Gets the PortInst name from this port and the specified index

Parameters:

index - The index to get from the port

Returns:

The name of the PortInst for the specified index

getPortIndexFromNameIndex

public int getPortIndexFromNameIndex(int namedIndex)

Gets the internal port instance index from the named index for this port. Given a bussed port 'bus[4:0]', the bus has an ordered list of named indices [4, 3, 2, 1, 0]. If the named index is 'bus[1]', the port index is 3. When the bus is specified using a big endian scheme ('bus[0:4]'), the named index and port index match if the bus range starts at 0. However, buses can begin with a non-zero index, such as 'bus[2:5]' ([2, 3, 4, 5]), in which case the port index for the named 'bus[3]' is actually offset and is 5.

Parameters:

namedIndex - The named index as what appears in the port instance name.

Returns:

The internal port index stored as a class member variable in the port instance.

exportEDIF

public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache,
                       boolean stable)
                throws IOException

Throws:

IOException

exportEDIFBusName

public void exportEDIFBusName(OutputStream os,
                              EDIFWriteLegalNameCache<?> cache)
                       throws IOException

Writes out valid EDIF syntax the name and/or rename of this port to the provided output writer.

Parameters:

os - The stream to export the EDIF syntax to.

Throws:

IOException

getParentCell

public EDIFCell getParentCell()

Returns:

the parentCell

setParentCell

public void setParentCell(EDIFCell parentCell)

Parameters:

parentCell - the parentCell to set

isBus

public boolean isBus()

Returns:

getBitBlastedIndicies

public int[] getBitBlastedIndicies()

isBusRangeEqual

public boolean isBusRangeEqual(EDIFPort otherPort)