SSHAFT Design Flow Directive Reference

BWRC
Home

SSHAFT
Home

Reference
Manual

This page defines all of the design flow directives, which are the parameters to be included in Simulink subsystem masks and properties embedded in EDIF files which drive the design flow.  The top-level directive is bjcType.  This means that the semantics associated with other directives are interpreted according the value bjcType for that system.

In addition to bjcType, the directives bjcSystemName, bjcPortNum, bjcPortIn#, bjcPortOut#, and bjcPortEn are added by BCC to the EDIF view properties.

bjcDistProp

Appearing in	Simulink Subsystem Mask Parameters
Description	If defined for an ICMacro (or ICWire), the value provides a comma-separated list of mask variables which distiguish the eventual EDIF cell definition (or net definition) from other cells (nets) with the same input and output ports.  A good example would be a mask variable which distinguishes an adder cell as ripple-carry or carry-bypass
Possible Values	A comma-separated list of subsystem mask variable names Required Parameters: bjcDistPropType
Default Value

bjcDistPropType

Appearing in	Simulink Subsystem Mask Parameters
Description	Specifies the types for the list of mask variables given in bjcDistProp.
Possible Values	A comma-separated list of the following: IsInt - the variable's value is an integer IsVal - the variable's value is a floating point number NOTE: Strings are not allowed for this construct.  Providing this capability would require extensive modification to the netlister (bcc).
Default Value	none

bjcInst_ClockPeriod

Appearing in	Simulink Subsystem Mask Parameters, EDIF instance properties
Description	Gives the clock period (sample time) for the given macro in Simulink.  This property is compared to the Clock Period properties of other macros during the creation of clock domains.
Possible Values	A string containing a floating point, integer, or scientific notation value. NOTE: This property cannot be added to a subsystem contained in the same library as the top-level system.  This is due to a bug in bcc.
Default Value	none

bjcInst_FlattenToAbs

Appearing in	Simulink Subsystem Mask Parameters, EDIF instance properties
Description	Indicates that the logical hierarchy contained in the given instance should be flattened (to the abstract views) into the cell which contains the instance during creation of the physical hierarchy.
Possible Values	yes - the instance will be flattened no - the instance will not be flattened
Default Value	off

bjcInst_GroundDomain

Appearing in	Simulink Subsystem Mask Parameters, EDIF instance properties
Description	Indicates that the underlying subsystem should be attached to the ground domain named by the value of this parameter.  The name of the resulting global ground net in the physical design will be the concatenation of the ground prefix (given by the StitchGroundDomainPrefix tech-file variable), the domain name given by this parameter, and the "!" character.
Possible Values
Default Value	None.  If unspecified, the subsystem will be connected to the default ground rail specified by the SshaftGlobalGroundNetName tech-file variable.

bjcInst_SupplyDomain

Appearing in	Simulink Subsystem Mask Parameters, EDIF instance properties
Description	Indicates that the underlying subsystem should be attached to the supply domain named by the value of this parameter.  The name of the resulting global supply net in the physical design will be the concatenation of the supply prefix (given by the StitchSupplyDomainPrefix tech-file variable), the domain name given by this parameter, and the "!" character.
Possible Values
Default Value	None.  If unspecified, the subsystem will be connected to the default power rail specified by the SshaftGlobalSupplyNetName tech-file variable.

bjcPortEn

Appearing in	EDIF view properties
Description	Specifies the name and fixed-point type of the enable port for the Simulink system corresponding to the cell.
Possible Values	A string containing the port name and 3 integers separated by spaces: "name sign mant guard" where sign is the number of sign bits (0 or 1), mant is the number of mantissa bits (total number of bits), and guard is the number of guard bits (i.e. the number of bits representing the whole part of the number, rather than the fractional part.
Default Value	none

bjcPortIn#

Appearing in	EDIF view properties
Description	Specifies the name and fixed-point type of input port number # for the Simulink system corresponding to the cell.
Possible Values	A string containing the port name and 3 integers separated by spaces: "name sign mant guard" where sign is the number of sign bits (0 or 1), mant is the number of mantissa bits (total number of bits), and guard is the number of guard bits (i.e. the number of bits representing the whole part of the number, rather than the fractional part.
Default Value	none

bjcPort

Appearing in	EDIF view properties
Description	Specifies the number of input, output, and enable ports which existed in the original Simulink system
Possible Values	A string containing three integers separated by a space: "inports outports enable" Where inports and outports are numbers greater than or equal to zero, and enable is either 0 or 1.
Default Value	none

bjcPortOut#

Appearing in	EDIF view properties
Description	Specifies the name and fixed-point type of output port number # for the Simulink system corresponding to the cell.
Possible Values	A string containing the port name and 3 integers separated by spaces: "name sign mant guard" where sign is the number of sign bits (0 or 1), mant is the number of mantissa bits (total number of bits), and guard is the number of guard bits (i.e. the number of bits representing the whole part of the number, rather than the fractional part.
Default Value	none

bjcPortTypeIn#

Appearing in	Simulink Subsystem Mask Parameters
Description	Specifies the Simulink Fixed-Point type of subsystem input port (e.g. bjcPortTypeIn1, bjcPortTypeIn2, etc.).  Required for all ICDesign input ports.
Possible Values	sfrac(x), sfrac(x,y), ufrac(x), ufrac(x,y), sint(x), uint(x)
Default Value	none

bjcPortTypeOut#

Appearing in	Simulink Subsystem Mask Parameters
Description	Specifies the Simulink Fixed-Point type of subsystem output port (e.g. bjcPortTypeOut1, bjcPortTypeOut2, etc.).  Required for all ICMacro output ports.
Possible Values	sfrac(x), sfrac(x,y), ufrac(x), ufrac(x,y), sint(x), uint(x)
Default Value	none

bjcSystemName

Appearing in	EDIF view properties
Description	Gives the full path name (relative to the containing library) of the Simulink System corresponding to the cell containing the property.
Possible Values	A set of identifiers which conform to global naming conventions separated by dot "." character. e.g.  "fundamental.Add"
Default Value	none

bjcType

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	The top-level parameter which determines how the design flow will attempt to process the block.
Possible Values	ICDesign Signifies the the underlying system will be traversed. Required Parameters: bjcPortTypeIn#   Optional Parameters: bjcViewName ICMacro Signifies that the system underlying the subsystem mask will not be traversed. Required Parameters: bjcPortTypeOut# , bjcView_Generator or bjcView_Implementation  Optional Parameters: bjcViewName, bjcAddClk, bjcDistProp, bjcInst_ClockPeriod, bjcView_Scan,  bjcView_SeparateAbgen ICWire Signifies that the mask represents a wiring construct which will not correspond to any cells or transistors in the physical design. Required Parameters: none Optional Parameters: bjcDistProp
Default Value	none

bjcViewName

Appearing in	Simulink Subsystem Mask Parameters, EDIF view name
Description	Specifies the view name that will appear in the output EDIF file for this cell.
Possible Values	any identifier which follows naming conventions
Default Value	autoLayout

bjcView_ClockPort

Appearing in	EDIF view properties
Description	Specifies the name of the clock port for the cell.  This property is normally added automatically during the macro-generation step, but it can be added manually for pre-designed cores.
Possible Values	A string containing a port name string "clock-port"
Default Value	none

bjcView_FlattenToAbs

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Indicates that the logical hierarchy contained in the given cell should be flattened to a single cell (containing only abstract views) during creation of the physical hierarchy.
Possible Values	yes - the cell view will be flattened no - the cell view will not be flattened
Default Value	off

bjcView_Generator

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Provides a command to create a generated view of an ICMacro
Possible Values	any unix shell generator command or skill generator command e.g.   bjcVHDLSynth( ?file "/tools/sshaft/design/scf1/Recomb_Filter.vhd" ?entity "Recomb_Filter") Required Parameters: bjcView_GeneratorPlatform
Default Value	none

bjcView_GeneratorPlatform

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Specifies the execution platform for an ICMacro generator
Possible Values	unix_step, unix_prog, skill_step, skill_proc
Default Value	skill_step

bjcView_GlobalConnect

Appearing in	EDIF view properties
Description	Specifies that the given port on the current cell should be connected to the given global net.  Also specifies that the global net should be connected to the given port at the top level of the design hierarchy.  This parameter gives macros the ability to add special off-chip connections.
Possible Values	A string containing one port name string, one net name string, one top-level port name string, and a direction string separated by single spaces "port-name global-net top-level-port direction" where direction is "input", "output", or "inputOutput"
Default Value	none

bjcView_Implementation

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Specifies the implementation for a module.  Modules appear in the fundamental library.  The generator for each implementation is defined in the MacroGenTypes techfile variable.
Possible Values	At present, only integer values are allowed
Default Value	none

bjcView_Scan

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Specifies whether or not any flip-flops appearing in the cell should be swapped with scanable flip flops for insertion into the scan chain.
Possible Values	1 - swap flip flops with scanable versions 0 - do not modify flip-flops
Default Value	0

bjcView_ScanPorts

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Specifies the scan-enable, scan-in and scan-out ports for the cell.  This property allows specification of multiple scan-in and scan-out ports, however, they will all be stitched together into the same scan chain.  This property is normally added automatically during the macro-generation step, but a value added manually in the Subsystem Mask Parameters will override the automatic value.
Possible Values	A string containing at least three port name strings separated by a space "scan-enable scan-in1 scan-out1 scan-in2 scan-out2 ..."
Default Value	none

bjcView_UseAbstract

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Instructs the flow to convert the abstract views for the given library and cell names from DFII to Pillar.  The abstract must exist prior to running the flow and is usually part of a library defined with bjcView_UseCdsLib
Possible Values	( "libname1" "cellname1" ) ( "libname2" "cellname2" ) ... Required Parameters: bjcView_UseCdsLib
Default Value	none

bjcView_UseCdsLib

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Instructs the flow to use an existing Cadence DFII Library
Possible Values	( "libname1" "libpath1" ) ( "libname2" "libpath2" ) ...
Default Value	none

bjcView_UseSynLib

Appearing in	Simulink Subsystem Mask Parameters, EDIF view properties
Description	Specifies a list of Synopsys black-box libraries to be linked when running Design Compiler or Module Compiler
Possible Values	( "libpath1.db" "libpath2.db" ... )
Default Value	none