Extra layout options

The following options have been added to the standard set of ELK options. They contain additional metadata about the netlist that helps frontends interact with the backend.#

de.thkoeln.fentwums.netlist.backend.signalname

  • Shortened option key: signalname
  • Type: String
  • Intended use: Contains the name of the signal this edge belongs to
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.signalindex

  • Shortened option key: signalindex
  • Type: Integer
  • Intended use: Contains the bitindex of the signal this edge belongs to. It is globally unique within the netlist and is a positive integer greater than 1
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.cellname

  • Shortened option key: cellname
  • Type: String
  • Intended use: Contains the name of the cell described by this node
  • Target: Nodes

de.thkoeln.fentwums.netlist.backend.celltype

  • Shortened option key: celltype
  • Type: String
  • Intended use: Contains the type of the cell described by this node. Constant drivers are of type Constant driver. A list of the celltypes yosys is able to generate can be found here.
  • Target: Nodes

de.thkoeln.fentwums.netlist.backend.location-path

  • Shortened option key: location-path
  • Type: String
  • Intended use: Contains the location of the cell or part of the signal described by this element inside the netlist hierarchy
  • Targets: Nodes and Edges

de.thkoeln.fentwums.netlist.backend.src-location

  • Shortened option key: src-location
  • Type: String
  • Intended use: Contains the location of the HDL-Code that is represented (in part or completely) by this element. Contains the absolute file path as well as line and column numbers
  • Targets: Nodes and Edges

de.thkoeln.fentwums.netlist.backend.signalvalue

  • Shortened option key: signalvalue
  • Type: String
  • Intended use: Contains the current value of the signal represented by this edge. Each character is the value of one of the contained bitindices.
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.index-in-signal

  • Shortened option key: index-in-signal
  • Type: Integer
  • Intended use: Contains the index of the signal described by this edge inside its containing signal (a vector). -1 if no containing signal exists
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.signaltype

  • Shortened option key: signaltype
  • Type: String
  • Value: One of CONSTANT, BUNDLED_CONSTANT, BUNDLED, SINGLE or UNDEFINED
  • Intended use: Contains information about the type of signal represented by this edge
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.port-group-name

  • Shortened option key: port-group-name
  • Type: String
  • Intended use: Contains the group a port belongs to, e.g. D, Q, S ...
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.font-size

  • Shortened option key: font-size
  • Type: double
  • Intended use: The font size of the label this attribute is attached to
  • Target: Labels

de.thkoeln.fentwums.netlist.backend.not-connected

  • Shortened option key: not-connected
  • Type: boolean
  • Intended use: Any port where this option is set to true does not have outgoing or incoming connections. The viewer can therefore use the value of this option to add additional symbols showing the connectedness of ports
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.index-in-port-group

  • Shortened option key: index-in-port-group
  • Type: Integer
  • Intended use: Contains the index of the port inside the port group it belongs to
  • Target: Edges

de.thkoeln.fentwums.netlist.backend.canonical-index-in-port-group

  • Shortened option key:canonical-index-in-port-group
  • Type: Integer
  • Intended use: Contains the index of the port as described by the HDL sources. Can therefore be negative and may not start at index 0
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.canonical-bundle-lower-index-in-port-group

  • Shortened option key: canonical-bundle-lower-index-in-port-group
  • Type: Integer
  • Intended use: Contains the lowest contained canonical index of the bundle contained in this port. The range is continous between lower and upper limit
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.canonical-bundle-upper-index-in-port-group

  • Shortened option key: canonical-bundle-upper-index-in-port-group
  • Type: Integer
  • Intended use: Contains the highest contained canonical index of the bundle contained in this port
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.port-type

  • Short option key: port-type
  • Type: String
  • Value: One of SIGNAL_SINGLE, SIGNAL_MULTIPLE, CONSTANT_SINGLE or CONSTANT_MULTIPLE
  • Inteded use: Describes whether a port contains only one or multiple signals and whether they are constant or not
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.port-direction

  • Shortened option key: port-direction
  • Type: String
  • Value: One of UNKNOWN, INPUT, OUTPUT or INOUT
  • Intended use: Describes the direction of the port description for the hierarchy viewer frontend
  • Target: Ports

de.thkoeln.fentwums.netlist.backend.hierarchy-ancestor-path

  • Shortened option key: hierarchy-ancestor-path
  • Type: String
  • Intended use: Contains the path of the containing entity for a text-based hierarchy viewer
  • Target: Nodes

de.thkoeln.fentwums.netlist.backend.hierarchy-container-subnode-type

  • Shortened option key: hierarchy-container-subnode-type
  • Type: String
  • Value: One of NAME, TYPE, PARAMETERS or PORTS
  • Describes which section of the entities module representation is covered by this node
  • Target: Nodes