byucc.jhdl.Xilinx.Virtex
Class bufg_ann

java.lang.Object
  byucc.jhdl.base.Nameable
      byucc.jhdl.base.Node
          byucc.jhdl.base.Cell
              byucc.jhdl.base.Annotation
                  byucc.jhdl.Xilinx.XilinxAnn
                      byucc.jhdl.Xilinx.Virtex.bufg_ann

All Implemented Interfaces:

BooleanFlags, PreDefinedSchematic, TreeListable, UnmappableCell

public final class bufg_ann

extends XilinxAnn

implements UnmappableCell, PreDefinedSchematic

Each of the BUF*_ANN classes implements an Annotation-only buffer, i.e. with no simulation model. This is to allow the user to set up net constraints that aren't supported natively by JHDL (i.e. clock net setup, etc.). The BUFG cell is a global buffer which distributes high-fanout clock signals throughout the device. For an XC4000 design, you can use a maximum of eight BUFG symbols (assuming that no specific BUFGP or BUFGS buffers are specified). The BUFG is converted to a BUFGP or BUFGS for the XC4000 architecture. The BUFGE is a global buffer that uses the 'early' routes on the device. The BUFGLS cell is a global buffer cell which distributes high-fanout signals throughout the device. The BUFGLS uses low-skew modes on the I/O buffers. The BUFGP is a primary global buffer. The BUFGS is a secondary global buffer. Both cells can drive any of four global vertical routes per column of CLBs. Each one of the four global vertical lines can drive the CLB clock (K) pin directly, and a small subset of the other CLB pins, depending on the type of buffer and the position (refer to the library guide). The JHDL XC4000 libraries model all of these cells as Annotations, meaning that they have no behavioral model. (Source: XACT Libraries Guide, pg. 3-87, Xilinx Corporation, 1994.)

Field Summary

static CellInterface[]	cell_interface The port interface for: bufg_ann i : in (1) o : out (1)
static java.lang.String	cellname The static cellname (netlist reference name) for bufg

Fields inherited from class byucc.jhdl.base.Cell

BOOLEAN, CELL_NAME_DECLARATION, CellInterfaceDeterminesUniqueNetlistStructure, DETERMINE_FROM_STRING, GENERICS_DECLARATION, implicit_interface, IMPLICIT_INTERFACE_DECLARATION, INTEGER, INTERFACE_DECLARATION, LONG, PORT_IOS_DECLARATION, PORT_NAMES_DECLARATION, PORT_NET_NAMES_DECLARATION, PORT_PROPERTIES, PORT_WIDTHS_DECLARATION, SIGN_EXT, STRING, ZERO_PAD

Fields inherited from interface byucc.jhdl.apps.Viewers.Schematic.PreDefinedSchematic

PreDefinedSchematic_ADD, PreDefinedSchematic_ADDSUB, PreDefinedSchematic_AND, PreDefinedSchematic_BUF, PreDefinedSchematic_CONST, PreDefinedSchematic_GEN, PreDefinedSchematic_GND, PreDefinedSchematic_INC, PreDefinedSchematic_INV, PreDefinedSchematic_MUX, PreDefinedSchematic_NAND, PreDefinedSchematic_NOR, PreDefinedSchematic_OR, PreDefinedSchematic_PULLDOWN, PreDefinedSchematic_PULLUP, PreDefinedSchematic_REG, PreDefinedSchematic_SHL, PreDefinedSchematic_SHR, PreDefinedSchematic_TBUF, PreDefinedSchematic_VCC, PreDefinedSchematic_XNOR, PreDefinedSchematic_XOR

Fields inherited from interface byucc.jhdl.base.BooleanFlags

ANTECEDANT_IS_BEHAVIORALLY_MODELED, ASYNC_PORT, ASYNCHRONOUS_RESOLVED, ATOMICALLY_PLACEABLE, ATOMICALLY_UNMAPPABLE, BEHAVIORALLY_MODELED_BRANCH, CLK_PORT, CLOCK_METHOD_IMPLEMENTED_BY_USER, CLOCK_METHOD_IS_DISABLED, CLOCKABLE_IS_SCHEDULED, DANGLING_IS_OK, DELETE_MARK, FATAL_BUILD_ERROR_OCCURED, HAS_BEEN_TRACED, HAS_USER_SPECIFIED_NAME, HWUPDATE, IMPLICIT_PORT, IN_CLK_PORT, IN_PORT, INOUT_PORT, IO_TYPE_FLAGS, IS_BEHAVIORALLY_MODELED, IS_ON_BUILD_STACK, IS_ON_PROP_LIST, IS_PLACED, METHODS_IMPLEMENTED_BY_USER, NETLISTABLE, ORIG_WIRE_IS_ATOMIC, OUT_PORT, PLACEMENT_IS_LOCKED, PROPAGATE_METHOD_IMPLEMENTED_BY_USER, PROPAGATE_METHOD_IS_DISABLED, RECURSION_FLAG, RESET_METHOD_IMPLEMENTED_BY_USER, SIMULATEABLE, SOURCELESS_IS_OK, SYNC_PORT, VISIBLE

Constructor Summary

protected	bufg_ann(Node parent) Used only by child classes to pass up the parent cell.
	bufg_ann(Node parent, ArgBlockList abl) Constructs a new bufg_ann, connecting its ports as given by the String-Wire pairs in the ArgBlockList.
protected	bufg_ann(Node parent, java.lang.String name) Used only by child classes to pass up the parent cell and instance name.
	bufg_ann(Node parent, java.lang.String instanceName, ArgBlockList abl) Constructs a new bufg_ann, connecting its ports as given by the String-Wire pairs in the ArgBlockList.
	bufg_ann(Node parent, java.lang.String instanceName, java.lang.String s0, Wire w0, java.lang.String s1, Wire w1) Constructs a new bufg_ann, connecting each Wire to the port whose name is given by the accompanying String parameter The initial String parameter specifies the instance name.
	bufg_ann(Node parent, java.lang.String s0, Wire w0, java.lang.String s1, Wire w1) Constructs a new bufg_ann, connecting each Wire to the port whose name is given by the accompanying String parameter
	bufg_ann(Node parent, java.lang.String instanceName, Wire i, Wire o) Constructs a new bufg_ann.
	bufg_ann(Node parent, Wire i, Wire o) Constructs a new bufg_ann.

Method Summary

boolean	cellInterfaceDeterminesUniqueNetlistStructure() When false, the default behavior of this method, each cell will list itself separately in a netlist, guaranteeing that the netlist will not have invalid data at the expense of a larger file-size.
java.lang.String	getCellName() Access the cell name associated with a derived class.
static void	main(java.lang.String[] argv)
static void	test()
int	type() This method returns one of the predefined schematic constants to identify the type of this cell.

Methods inherited from class byucc.jhdl.base.Annotation

hasBehaviorInClockMethod, hasBehaviorInPropagateMethod, needsToBeAsynchronouslyScheduled

Methods inherited from class byucc.jhdl.base.Cell

addPort, addPorts, addProperties, addProperties, addProperty, addProperty, addProperty, addProperty, antecedantIsBehaviorallyModeled, antecedantIsBehaviorallyModeled, behavioralModelIsAvailable, bind, bind, bind, bind, clk, connect, connectAllWires, connectOptional, constructSubCell, constructSubCellNoImplicitPorts, defaultSimulationModelIsBehavioral, disableAllBehavioralModels, disableBehavioralModel, enableBehavioralModel, getArgument, getAttachedPort, getAttachedWire, getAttachedWireNoException, getCellNetlist, getCellNetList, getCellNetlist, getCellNetlist, getDescendents, getFlatNetlist, getFlatNetlistableChildren, getGeneric, getHeight, getNetlistableChildren, getPlacementInfo, getPortProperties, getPortRecord, getPortRecords, getProperties, getProperty, getPropertyValue, getSinkWires, getSourceWires, getSubCellClass, getUniqueCellName, getWidth, getX, getY, hasBeenTraced, hasBeenTraced, hasPort, hasPorts, in, in, inout, inout, isAsynchronouslyScheduled, isAsynchronouslyScheduled, isAsynchronousSourceSinkResolved, isBehaviorallyModeled, isBehaviorallyModeledBranch, isInput, isLeafCell, isNetlistable, isNetlistable, isNetlistablePort, isNetlistLeaf, isNotNetlistable, isNotNetlistablePort, isNotVisible, isOutput, isPlaceable, isPlaceable, isPlaced, isPlaced, isPlacementLocked, isRoot, isSimulateable, isSimulateable, isSink, isSource, isVisible, isVisible, join, lockPlacement, nc, out, out, param, popHierarchy, port, port, port, postorderCheck, preorderCheck, pushHierarchy, pushHierarchy, pushHierarchy, pushHierarchy, pushHierarchyNoImplicitPorts, pushHierarchyNoImplicitPorts, removeAllUnconnectedPorts, removePort, removeProperty, replaceProperty, replaceProperty, resetBehavioralModelsToDefaults, setAsynchronousSourceSinkResolved, setGeneric, setHeight, setNotNetlistable, setNotNetlistable, setNotVisible, setNotVisible, setPlacementInfo, setPortNotNetlistable, setPortNotNetlistable, setProperty, setWidth, subClassDelete, toString, uniquifyCell, userDefinedClockCount, verifyAndCleanup

Methods inherited from class byucc.jhdl.base.Node

addObservable, addSimulatorCallback, checkAll, delete, getBuildingFlag, getChildren, getChildrenEnumeration, getDefaultClock, getInstanceName, getParent, getParentCell, getRelatives, getSystem, getWires, optimize, orphanAllowed, printAllChildren, printTree, removeSimulatorCallback, setDefaultClock

Methods inherited from class byucc.jhdl.base.Nameable

caseSensitivity, caseSensitivity, disableNameClashChecking, getFullName, getFullNameNoTestBench, getHierNameNoTestBench, getInstanceNo, getInstanceNumber, getLeafName, getLeafName, getRelativeName, getUserName, getUserName, hasUserSpecifiedName, isDescendantOf, setInstanceNumber

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cellname

public static final java.lang.String cellname

The static cellname (netlist reference name) for bufg

See Also:

Constant Field Values

cell_interface

public static CellInterface[] cell_interface

The port interface for: bufg_ann i : in (1) o : out (1)

Constructor Detail

bufg_ann

protected bufg_ann(Node parent)

Used only by child classes to pass up the parent cell.

Parameters:

parent - Parent cell

bufg_ann

protected bufg_ann(Node parent,
                   java.lang.String name)

Used only by child classes to pass up the parent cell and instance name.

Parameters:

parent - Parent cell

name - Instance name of the cell

bufg_ann

public bufg_ann(Node parent,
                Wire i,
                Wire o)

Constructs a new bufg_ann.

Parameters:

parent - The parent Cell to the bufg_ann

i - The Wire to be connected to input port i

o - The Wire to be connected to output port o

bufg_ann

public bufg_ann(Node parent,
                java.lang.String instanceName,
                Wire i,
                Wire o)

Constructs a new bufg_ann. The initial String parameter specifies the instance name.

Parameters:

parent - The parent Cell to the bufg_ann

instanceName - The instance name of the bufg_ann

i - The Wire to be connected to input port i

o - The Wire to be connected to output port o

bufg_ann

public bufg_ann(Node parent,
                java.lang.String s0,
                Wire w0,
                java.lang.String s1,
                Wire w1)

Constructs a new bufg_ann, connecting each Wire to the port whose name is given by the accompanying String parameter

Parameters:

parent - The parent Cell to the bufg_ann

s0 - The name of the port to which w0 will be connected

w0 - The Wire to be connected to the port specified by s0

s1 - The name of the port to which w1 will be connected

w1 - The Wire to be connected to the port specified by s1

bufg_ann

public bufg_ann(Node parent,
                java.lang.String instanceName,
                java.lang.String s0,
                Wire w0,
                java.lang.String s1,
                Wire w1)

Constructs a new bufg_ann, connecting each Wire to the port whose name is given by the accompanying String parameter The initial String parameter specifies the instance name.

Parameters:

parent - The parent Cell to the bufg_ann

instanceName - The instance name of the bufg_ann

s0 - The name of the port to which w0 will be connected

w0 - The Wire to be connected to the port specified by s0

s1 - The name of the port to which w1 will be connected

w1 - The Wire to be connected to the port specified by s1

bufg_ann

public bufg_ann(Node parent,
                ArgBlockList abl)

Constructs a new bufg_ann, connecting its ports as given by the String-Wire pairs in the ArgBlockList. Any generic assignments are made through String-String pairs in the ArgBlockList.

Parameters:

parent - The parent Cell to the bufg_ann

abl - The list of String-Wire pairs for port assignments, and String-String pairs for generic assignments.

bufg_ann

public bufg_ann(Node parent,
                java.lang.String instanceName,
                ArgBlockList abl)

Constructs a new bufg_ann, connecting its ports as given by the String-Wire pairs in the ArgBlockList. Any generic assignments are made through String-String pairs in the ArgBlockList. The initial String parameter is the instance name.

Parameters:

parent - The parent Cell to the bufg_ann

instanceName - The instance name of the bufg_ann

abl - The list of String-Wire pairs for port assignments, and String-String pairs for generic assignments.

Method Detail

getCellName

public java.lang.String getCellName()

Description copied from class: Cell

Access the cell name associated with a derived class. The cellname field is lazily evaluated on the first call of this method. Can be overriden to make cellname different by instance. If the field does not exist, this defaults to the classname.

Overrides:

getCellName in class Cell

Returns:

the cell name associated with a derived class, null if not declared.

cellInterfaceDeterminesUniqueNetlistStructure

public final boolean cellInterfaceDeterminesUniqueNetlistStructure()

Description copied from class: Cell

When false, the default behavior of this method, each cell will list itself separately in a netlist, guaranteeing that the netlist will not have invalid data at the expense of a larger file-size. Overriding this method to return true allows JHDL to save memory and netlists to be smaller by sharing the netlist structures that are guaranteed to be identical. NOTE: Do not override this unless every possible condition responsible for structural differences in a class (types and amount of children cells created, and arrangements of wires connected to ports) is included in the cellInterface[] of that class.

Overrides:

cellInterfaceDeterminesUniqueNetlistStructure in class Cell

Returns:

false if not overridden, preventing all memory sharing

type

public int type()

Description copied from interface: PreDefinedSchematic

This method returns one of the predefined schematic constants to identify the type of this cell.

Specified by:

type in interface PreDefinedSchematic

Returns:

A predefined schematic constant

main

public static void main(java.lang.String[] argv)

test

public static void test()