byucc.jhdl.Xilinx.XC4000
Class startup

java.lang.Object
  byucc.jhdl.base.Nameable
      byucc.jhdl.base.Node
          byucc.jhdl.base.Cell
              byucc.jhdl.base.VisibleAnnotation
                  byucc.jhdl.Xilinx.XC4000.startup

All Implemented Interfaces:

BooleanFlags, PreDefinedSchematic, TreeListable, UnmappableCell

public final class startup

extends VisibleAnnotation

implements UnmappableCell, PreDefinedSchematic

The STARTUP symbol is used for initializing the Global Set/Reset, global 3-state control, and the user configuration clock. The GSR input, when high, sets or resets every flip-flop on the devices, depending on the initialization state (S or R) of the flip-flop. Following configuration, the global 3-state control (GTS), when high, forces all the IOB outputs into high-impedance mode, which isolates the device outputs from the circuit but leaves the inputs active. The configuration clock input (CLK) must be connected to a user clock if the start-up of the device is synchronized with the user clock. Also, 'user clock' must be selected in the MakeBits program. The STARTUP outputs (Q2, Q3, Q1Q4, and DONEIN) display the progress / status of the start-up process during the configuration. (Source: XACT Libraries Guide, pg. 3-442, Xilinx Corporation, 1994.)

Field Summary

static CellInterface[]	cell_interface The port interface for: startup gsr : in (1) gts : in (1) clk : in (1) q2 : out (1) q3 : out (1) q1q4 : out (1) donein : out (1)
static java.lang.String	cellname The static cellname (netlist reference name) for startup

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	startup(Node parent) Used only by child classes to pass up the parent cell.
	startup(Node parent, ArgBlockList abl) Constructs a new startup, connecting its ports as given by the String-Wire pairs in the ArgBlockList.
protected	startup(Node parent, java.lang.String name) Used only by child classes to pass up the parent cell and instance name.
	startup(Node parent, java.lang.String instanceName, ArgBlockList abl) Constructs a new startup, connecting its ports as given by the String-Wire pairs in the ArgBlockList.
	startup(Node parent, java.lang.String instanceName, java.lang.String s0, Wire w0, java.lang.String s1, Wire w1, java.lang.String s2, Wire w2, java.lang.String s3, Wire w3, java.lang.String s4, Wire w4, java.lang.String s5, Wire w5, java.lang.String s6, Wire w6) Constructs a new startup, connecting each Wire to the port whose name is given by the accompanying String parameter The initial String parameter specifies the instance name.
	startup(Node parent, java.lang.String s0, Wire w0, java.lang.String s1, Wire w1, java.lang.String s2, Wire w2, java.lang.String s3, Wire w3, java.lang.String s4, Wire w4, java.lang.String s5, Wire w5, java.lang.String s6, Wire w6) Constructs a new startup, connecting each Wire to the port whose name is given by the accompanying String parameter
	startup(Node parent, java.lang.String instanceName, Wire gsr, Wire gts, Wire clk, Wire q2, Wire q3, Wire q1q4, Wire donein) Constructs a new startup.
	startup(Node parent, Wire gsr, Wire gts, Wire clk, Wire q2, Wire q3, Wire q1q4, Wire donein) Constructs a new startup.

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.VisibleAnnotation

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 startup

See Also:

Constant Field Values

cell_interface

public static CellInterface[] cell_interface

The port interface for: startup gsr : in (1) gts : in (1) clk : in (1) q2 : out (1) q3 : out (1) q1q4 : out (1) donein : out (1)

Constructor Detail

startup

protected startup(Node parent)

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

Parameters:

parent - Parent cell

startup

protected startup(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

startup

public startup(Node parent,
               Wire gsr,
               Wire gts,
               Wire clk,
               Wire q2,
               Wire q3,
               Wire q1q4,
               Wire donein)

Constructs a new startup.

Parameters:

parent - The parent Cell to the startup

gsr - The Wire to be connected to input port gsr

gts - The Wire to be connected to input port gts

clk - The Wire to be connected to input port clk

q2 - The Wire to be connected to output port q2

q3 - The Wire to be connected to output port q3

q1q4 - The Wire to be connected to output port q1q4

donein - The Wire to be connected to output port donein

startup

public startup(Node parent,
               java.lang.String instanceName,
               Wire gsr,
               Wire gts,
               Wire clk,
               Wire q2,
               Wire q3,
               Wire q1q4,
               Wire donein)

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

Parameters:

parent - The parent Cell to the startup

instanceName - The instance name of the startup

gsr - The Wire to be connected to input port gsr

gts - The Wire to be connected to input port gts

clk - The Wire to be connected to input port clk

q2 - The Wire to be connected to output port q2

q3 - The Wire to be connected to output port q3

q1q4 - The Wire to be connected to output port q1q4

donein - The Wire to be connected to output port donein

startup

public startup(Node parent,
               java.lang.String s0,
               Wire w0,
               java.lang.String s1,
               Wire w1,
               java.lang.String s2,
               Wire w2,
               java.lang.String s3,
               Wire w3,
               java.lang.String s4,
               Wire w4,
               java.lang.String s5,
               Wire w5,
               java.lang.String s6,
               Wire w6)

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

Parameters:

parent - The parent Cell to the startup

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

s2 - The name of the port to which w2 will be connected

w2 - The Wire to be connected to the port specified by s2

s3 - The name of the port to which w3 will be connected

w3 - The Wire to be connected to the port specified by s3

s4 - The name of the port to which w4 will be connected

w4 - The Wire to be connected to the port specified by s4

s5 - The name of the port to which w5 will be connected

w5 - The Wire to be connected to the port specified by s5

s6 - The name of the port to which w6 will be connected

w6 - The Wire to be connected to the port specified by s6

startup

public startup(Node parent,
               java.lang.String instanceName,
               java.lang.String s0,
               Wire w0,
               java.lang.String s1,
               Wire w1,
               java.lang.String s2,
               Wire w2,
               java.lang.String s3,
               Wire w3,
               java.lang.String s4,
               Wire w4,
               java.lang.String s5,
               Wire w5,
               java.lang.String s6,
               Wire w6)

Constructs a new startup, 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 startup

instanceName - The instance name of the startup

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

s2 - The name of the port to which w2 will be connected

w2 - The Wire to be connected to the port specified by s2

s3 - The name of the port to which w3 will be connected

w3 - The Wire to be connected to the port specified by s3

s4 - The name of the port to which w4 will be connected

w4 - The Wire to be connected to the port specified by s4

s5 - The name of the port to which w5 will be connected

w5 - The Wire to be connected to the port specified by s5

s6 - The name of the port to which w6 will be connected

w6 - The Wire to be connected to the port specified by s6

startup

public startup(Node parent,
               ArgBlockList abl)

Constructs a new startup, 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 startup

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

startup

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

Constructs a new startup, 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 startup

instanceName - The instance name of the startup

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()