byucc.jhdl.platforms.util
Class GenericUserCore

java.lang.Object
  byucc.jhdl.base.Nameable
      byucc.jhdl.base.Node
          byucc.jhdl.base.Cell
              byucc.jhdl.base.Structural
                  byucc.jhdl.Logic.LogicGates
                      byucc.jhdl.Logic.LogicStatic
                          byucc.jhdl.Logic.Logic
                              byucc.jhdl.platforms.util.GenericUserCore

All Implemented Interfaces:

BooleanFlags, Clockable, byucc.jhdl.base.Propagateable, TreeListable, UtilConstants

public class GenericUserCore

extends Logic

implements UtilConstants

Base class to be used for creating wrappers for user designs. This class is used to easily allow users the ability to connect the correct ports to their designs.

Field Summary

protected GenericProcessingElement

parent A reference to the JHDL parent of this circuit.

Fields inherited from class byucc.jhdl.Logic.Logic

ABOVE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_LSB, ALIGN_MSB, ALIGN_RIGHT, ALIGN_TOP, BELOW, DOWN, EAST_OF, LEFT_OF, MAX_PACK, NORTH_OF, ON, ONTOP, ONTOP_OF, RIGHT_OF, SOUTH_OF, TOLEFT, TORIGHT, UNCONSTRAINED, UP, WEST_OF

Fields inherited from class byucc.jhdl.Logic.LogicGates

tech_mapper

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.platforms.util.UtilConstants

directions, IN, NONE, OUT, TRISTATE, UNASSIGNED

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

GenericUserCore(Node parent)
Used by the extending class to create a GenericUserCore that has no instance name

GenericUserCore(Node parent, java.lang.String instance)
Used by the extending class to create a GenericUserCore that has an instance name

Method Summary

Wire	connect(java.lang.String portName, VPortInfo vport) New connect call for GenericUserCores.
Wire	connect(java.lang.String portName, VPortInfo vpi, java.lang.String enable) New connect call for GenericUserCores.
Wire	getEnableWire(java.lang.String enable) Finds the wire associated with the given enable port.
VPortInfo	wa(java.lang.String vport) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int index) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int top, int bottom) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int top, int bottom, java.lang.String attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int top, int bottom, java.lang.String[] attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int index, java.lang.String attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, int index, java.lang.String[] attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, java.lang.String attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.
VPortInfo	wa(java.lang.String vport, java.lang.String[] attrib) This method is used to build the VPortInfo objects which are passed to the specialized connect calls.

Methods inherited from class byucc.jhdl.Logic.Logic

clockDriver, clockDriver, connect_implicit_ports, connectImplicitPorts, constructSubCell, constructSubCellNoImplicitPorts, enableNewPlacement, enableNewPlacement, extend, extend, getDefaultClock, getDefaultTechMapper, getGlobalClock, getSinkCell, getSourceCell, getSourceCell, getSourceLeaf, getSourcePlaceable, getSourcePlaceableLeaf, getSubCellClass, getTechMapHint, getTechMapHint, getTechMapper, growAndShiftl, lockChildPlacement, lsb, lsb, map, map, map, map, map, map, map, map, map, map, map, map, map, map, map, map, map, map, map, msb, msb, msbIndx, netlist, netlist, netlist, netlist, netlist, netlist, netlist, netlist, padClock_o, padClock_o, padClock_o, padClock, padClock, padClock, padIn_o, padIn_o, padIn_o, padIn, padIn, padIn, padInout_o, padInout_o, padInout_o, padInout, padInout, padInout, padOut_o, padOut_o, padOut_o, padOut, padOut, padOut, padOutT_o, padOutT_o, padOutT_o, padOutT, padOutT, padOutT, place, place, place, place, place, place, place, place, place, place, place, place, place, place, place, place, place, printTechMapHints, range, rotate, rotate, scale, scale, setBBox, setDefaultTechMapper, setFloorPlannerIsMaster, setTechMappingEnabled, setWandH, signExtend_o, signExtend, signExtend, sink, source, takeBot_o, takeBot, takeBot, takeBotSigned_o, takeBotSigned, takeTop_o, takeTop, takeTop, techmap, techMappingEnabled, translate, translate, zeroExtend_o, zeroExtend, zeroExtend, zeroExtendRight_o, zeroExtendRight

Methods inherited from class byucc.jhdl.Logic.LogicStatic

add_o, add_o, and_o, and_o, and, and, buf_o, buf_o, buf, buf, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant, constant, constant, constant, constant, constant, constant, constant, constant, constant, gnd_o, gnd_o, gnd, gnd, gnd, gnd, mux_o, mux, nc, nc, nc, nc, nc, nc, not_o, not_o, not, not, or_o, or_o, or, or, reg_o, reg, vcc_o, vcc_o, vcc, vcc, vcc, vcc, wire, wire, wire, wire, xnor_o, xnor_o, xnor, xor_o, xor

Methods inherited from class byucc.jhdl.Logic.LogicGates

add_o, add_o, add_o, add_o, add_o, add_o, add, add, add, add, addsub_o, addsub_o, addsub_o, addsub_o, addsub_o, addsub_o, addsub, addsub, addsub, addsub, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and_o, and, and, and, and, and, and, and, and, and, and, and, and, and, and, and, and, and, and, ashiftr_o, ashiftr, ashiftr, buf_o, buf_o, buf, buf, checkValueRepresentableInWidth, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat_o, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant_o, constant, constant, constant, constant, constant, constant, constant, constant, constant, constant, gnd_o, gnd_o, gnd, gnd, gnd, gnd, mux_o, mux_o, mux_o, mux_o, mux_o, mux_o, mux, mux, mux, mux, mux, mux, name, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand_o, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nand, nc, nc, nc, nc, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor_o, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, nor, not_o, not_o, not, not, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or_o, or, or, or, or, or, or, or, or, or, or, or, or, or, or, or, or, or, or, pulldown, pulldown, pullup, pullup, reg_o, reg_o, reg_o, reg_o, reg, reg, reg, reg, regc_o, regc_o, regc_o, regc_o, regc, regc, regc, regc, regce_o, regce_o, regce_o, regce_o, regce, regce, regce, regce, regp_o, regp_o, regp_o, regp_o, regp, regp, regp, regp, regpe_o, regpe_o, regpe_o, regpe_o, regpe, regpe, regpe, regpe, regr_o, regr_o, regr_o, regr_o, regr, regr, regr, regr, regre_o, regre_o, regre_o, regre_o, regre, regre, regre, regre, regs_o, regs_o, regs_o, regs_o, regs, regs, regs, regs, regse_o, regse_o, regse_o, regse_o, regse, regse, regse, regse, shiftl_o, shiftl, shiftl, shiftr_o, shiftr, shiftr, sub_o, sub_o, sub_o, sub_o, sub_o, sub_o, sub, sub, sub, sub, tbuf_o, tbuf_o, tbuf, tbuf, vcc_o, vcc_o, vcc, vcc, vcc, vcc, wire, wire, wire, wire, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor_o, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xnor, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor_o, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor, xor

Methods inherited from class byucc.jhdl.base.Structural

behavioralModelIsAvailable, clock, clockMethodIsDisabled, clockMethodIsDisabled, clockMethodIsEnabled, clockMethodIsEnabled, defaultSimulationModelIsBehavioral, hasBeenTraced, hasBeenTraced, hasBehaviorInClockMethod, hasBehaviorInPropagateMethod, isAsynchronouslyScheduled, isAsynchronouslyScheduled, isFallingEdgeTriggered, isReadyToBeAsynchronouslyScheduled, isRisingEdgeTriggered, needsToBeAsynchronouslyScheduled, needsToBeClocked, propagate, propagateMethodIsDisabled, propagateMethodIsDisabled, propagateMethodIsEnabled, propagateMethodIsEnabled, reset, willUseHWUpdate, willUseHWUpdate

Methods inherited from class byucc.jhdl.base.Cell

addPort, addPorts, addProperties, addProperties, addProperty, addProperty, addProperty, addProperty, antecedantIsBehaviorallyModeled, antecedantIsBehaviorallyModeled, bind, bind, bind, bind, cellInterfaceDeterminesUniqueNetlistStructure, clk, connect, connectAllWires, connectOptional, disableAllBehavioralModels, disableBehavioralModel, enableBehavioralModel, getArgument, getAttachedPort, getAttachedWire, getAttachedWireNoException, getCellName, getCellNetlist, getCellNetList, getCellNetlist, getCellNetlist, getDescendents, getFlatNetlist, getFlatNetlistableChildren, getGeneric, getHeight, getNetlistableChildren, getPlacementInfo, getPortProperties, getPortRecord, getPortRecords, getProperties, getProperty, getPropertyValue, getSinkWires, getSourceWires, getUniqueCellName, getWidth, getX, getY, hasPort, hasPorts, in, in, inout, inout, 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, 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

parent

protected GenericProcessingElement parent

A reference to the JHDL parent of this circuit.

Constructor Detail

GenericUserCore

public GenericUserCore(Node parent)

Used by the extending class to create a GenericUserCore that has no instance name

Parameters:

parent - Parent of this cell, typically a derivative of GenericProcessingElement.

GenericUserCore

public GenericUserCore(Node parent,
                       java.lang.String instance)

Used by the extending class to create a GenericUserCore that has an instance name

Parameters:

parent - Parent of this cell, typically a derivative of GenericProcessingElement.

instance - Instance name for the GenericUserCore.

Method Detail

connect

public Wire connect(java.lang.String portName,
                    VPortInfo vport)

New connect call for GenericUserCores. This method will translate a VPortInfo object (returned by the wa() method ) into the correct wire and will connect this wire to the portname.

Parameters:

portName - Name of the port to connect to.

vport - VPortInfo object that contains the information needed to chose the correct wire.

Returns:

The wire returned from the "real" connect call.

connect

public Wire connect(java.lang.String portName,
                    VPortInfo vpi,
                    java.lang.String enable)

New connect call for GenericUserCores. This method will translate a VPortInfo object (returned by the wa() method ) into the correct wire and will connect this wire to the portname. This method also takes an enable wire for use in inferring tri-state pads. This connect call can only be used with out ports. This call will associate the output and its enable, as well as actually creating the enable wire. To get access to the enable wire, use the getEnableWire() method.

Parameters:

portName - Name of the port to connect to.

enable - Name of the enable port associated with the output wire referred to by the VPortInfo object.

Returns:

The wire returned from the "real" connect call.

getEnableWire

public Wire getEnableWire(java.lang.String enable)

Finds the wire associated with the given enable port. This method is necessary because the enable wires are generated automatically. This method allows the user to get a reference to the enable wire so that it can be used in the design.

Parameters:

enable - Name of the enable port.

Returns:

Wire created for enable port.

wa

public VPortInfo wa(java.lang.String vport,
                    int top,
                    int bottom)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a range of the port and does not allow for the passing of attributes.

Parameters:

vport - Name of the virtual port being accessed.

top - Index of the most significant bit of the wanted range.

bottom - Index of the least significant bit of the wanted range.

wa

public VPortInfo wa(java.lang.String vport,
                    int index)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a single bit of the port and does not allow for the passing of attributes.

Parameters:

vport - Name of the virtual port being accessed.

index - Index of the wanted bit.

wa

public VPortInfo wa(java.lang.String vport)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab all bits of the port and does not allow for the passing of attributes.

Parameters:

vport - Name of the virtual port being accessed.

wa

public VPortInfo wa(java.lang.String vport,
                    int top,
                    int bottom,
                    java.lang.String attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a range of the port.

Parameters:

vport - Name of the virtual port being accessed.

top - Index of the most significant bit of the wanted range.

bottom - Index of the least significant bit of the wanted range.

attrib - Attribute to be set on the port.

wa

public VPortInfo wa(java.lang.String vport,
                    int index,
                    java.lang.String attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a single bit of the port.

Parameters:

vport - Name of the virtual port being accessed.

index - Index of the wanted bit.

attrib - Attribute to be set on the port.

wa

public VPortInfo wa(java.lang.String vport,
                    java.lang.String attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab all bits of the port.

Parameters:

vport - Name of the virtual port being accessed.

attrib - Attribute to be set on the port.

wa

public VPortInfo wa(java.lang.String vport,
                    int top,
                    int bottom,
                    java.lang.String[] attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a range of the port.

Parameters:

vport - Name of the virtual port being accessed.

top - Index of the most significant bit of the wanted range.

bottom - Index of the least significant bit of the wanted range.

attrib - Attribute to be set on the port.

wa

public VPortInfo wa(java.lang.String vport,
                    int index,
                    java.lang.String[] attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab a single bit of the port.

Parameters:

vport - Name of the virtual port being accessed.

index - Index of the wanted bit.

attrib - Attribute to be set on the port.

wa

public VPortInfo wa(java.lang.String vport,
                    java.lang.String[] attrib)

This method is used to build the VPortInfo objects which are passed to the specialized connect calls. This version is used to grab all bits of the port.

Parameters:

vport - Name of the virtual port being accessed.

attrib - Attribute to be set on the port.