SharedDataBus class
A module with a bidirectional data bus for loading/reading data.
In real hardware, a shared data bus is common for:
- Loading filter coefficients from external memory
- Reading diagnostic status or filter output snapshots
Direction is controlled by writeEnable: when high, the module's
internal TriStateBuffer drives storedValue onto dataBus;
when low, the external driver owns the bus and the module latches
the incoming value into a register.
Exercises addInOut / LogicNet / TriStateBuffer / inout port
direction through the full ROHD stack: synthesis, hierarchy,
waveform capture, and DevTools rendering.
Constructors
-
Creates a SharedDataBus with a
dataWidth-bit bidirectional port.
Properties
- clkPin → Logic
-
Clock input.
no setter
- dataBus → Logic
-
The bidirectional data bus port.
no setter
- dataWidth → int
-
Data width in bits.
final
- definitionName → String
-
The definition name of this Module used when instantiating instances in
generated code.
no setterinherited
- hasBuilt → bool
-
Indicates whether this Module has had the build method called on it.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hierarchicalName → String
-
Returns the hierarchical name of this Module with the parent hierarchy
included, separated by
.s, e.g.top.mid.leaf. Because it depends on hierarchy, this is only valid after build has been called.no setterinherited -
inOuts
→ Map<
String, Logic> -
A map from inOut port names to this Module to corresponding Logic
signals.
no setterinherited
-
inputs
→ Map<
String, Logic> -
A map from input port names to this Module to corresponding Logic
signals.
no setterinherited
-
internalSignals
→ Iterable<
Logic> -
An Iterable of all Logics contained within this Module which are
not an input or output port of this Module.
no setterinherited
- name → String
-
The name of this Module.
finalinherited
-
outputs
→ Map<
String, Logic> -
A map from output port names to this Module to corresponding Logic
signals.
no setterinherited
- parent → Module?
-
The parent Module of this Module.
no setterinherited
- reserveDefinitionName → bool
-
If true, guarantees definitionName is maintained by a Synthesizer,
or else it will fail.
finalinherited
- reserveName → bool
-
If true, guarantees uniqueInstanceName matches name or else the
build will fail.
finalinherited
- resetPin → Logic
-
Reset input.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
signals
→ Iterable<
Logic> -
An Iterable of all Logics contained within this Module, including
inputs, outputs, and internal signals of this Module.
no setterinherited
- storedValue → Logic
-
The stored value (latched when the bus is driven externally).
no setter
-
structuredInterfacePortBindings
→ List<
StructuredInterfacePortBinding> -
The experimental structured-interface bindings registered on this module.
no setterinherited
-
subModules
→ Iterable<
Module> -
An Iterable of all Modules contained within this Module.
no setterinherited
- uniqueInstanceName → String
-
If this module has a parent, after build this will be a guaranteed
unique name within its scope.
no setterinherited
- writeEnablePin → Logic
-
Write-enable input.
no setter
Methods
-
addInOut(
String name, Logic source, {int width = 1}) → LogicNet -
Registers a signal as an inOut to this Module and returns an inOut
port that can be consumed inside this Module.
inherited
-
addInOutArray(
String name, Logic source, {List< int> dimensions = const [1], int elementWidth = 1, int numUnpackedDimensions = 0}) → LogicArray -
Registers and returns an inOut LogicArray port to this Module with
the specified
dimensions,elementWidth, andnumUnpackedDimensionsnamedname.inherited -
addInput(
String name, Logic source, {int width = 1}) → Logic -
Registers a signal as an input to this Module and returns an input
port that can be consumed.
inherited
-
addInputArray(
String name, Logic source, {List< int> dimensions = const [1], int elementWidth = 1, int numUnpackedDimensions = 0}) → LogicArray -
Registers and returns an input LogicArray port to this Module with
the specified
dimensions,elementWidth, andnumUnpackedDimensionsnamedname.inherited -
addInterfaceFrom<
InterfaceType extends Interface< (TagType> , TagType extends Enum>InterfaceType target, Interface< TagType> source, {Iterable<TagType> ? inputTags, Iterable<TagType> ? outputTags, Iterable<TagType> ? inOutTags, String uniquify(String original)?}) → InterfaceType -
Registers a deliberately constructed local
targetagainstsourceand returnstarget.inherited -
addInterfacePorts<
InterfaceType extends Interface< (TagType> , TagType extends Enum>InterfaceType source, {Iterable< TagType> ? inputTags, Iterable<TagType> ? outputTags, Iterable<TagType> ? inOutTags, String uniquify(String original)?}) → InterfaceType -
Registers
sourceon this Module and returns its internal clone.inherited -
addOutput(
String name, {int width = 1}) → Logic -
Registers an output to this Module and returns an output port that
can be driven by this Module or consumed outside of it.
inherited
-
addOutputArray(
String name, {List< int> dimensions = const [1], int elementWidth = 1, int numUnpackedDimensions = 0}) → LogicArray -
Registers and returns an output LogicArray port to this Module with
the specified
dimensions,elementWidth, andnumUnpackedDimensionsnamedname.inherited -
addPairConsumerFrom<
TargetInterfaceType extends PairInterface, SourceInterfaceType extends PairInterface> (TargetInterfaceType target, PairConsumer< SourceInterfaceType> source, {String uniquify(String original)?}) → TargetInterfaceType -
Registers
targetagainst a consumersourceendpoint and returns it.inherited -
addPairConsumerPorts<
InterfaceType extends PairInterface> (PairConsumer< InterfaceType> source, {String uniquify(String original)?}) → InterfaceType -
Registers a consumer
sourceendpoint and returns its internal clone.inherited -
addPairInterfaceFrom<
InterfaceType extends PairInterface> (InterfaceType target, PairInterface source, PairRole role, {String uniquify(String original)?}) → InterfaceType -
Registers a deliberately retyped pair
targetagainstsourceforroleand returnstarget.inherited -
addPairInterfacePorts<
InterfaceType extends PairInterface> (InterfaceType source, PairRole role, {String uniquify(String original)?}) → InterfaceType -
Registers
sourceforroleand returns its internal clone.inherited -
addPairProviderFrom<
TargetInterfaceType extends PairInterface, SourceInterfaceType extends PairInterface> (TargetInterfaceType target, PairProvider< SourceInterfaceType> source, {String uniquify(String original)?}) → TargetInterfaceType -
Registers
targetagainst a providersourceendpoint and returns it.inherited -
addPairProviderPorts<
InterfaceType extends PairInterface> (PairProvider< InterfaceType> source, {String uniquify(String original)?}) → InterfaceType -
Registers a provider
sourceendpoint and returns its internal clone.inherited -
addStructuredInterface<
InterfaceType extends Interface< (TagType> , TagType extends Enum>InterfaceType source, {Iterable< TagType> ? inputTags, Iterable<TagType> ? outputTags, Iterable<TagType> ? inOutTags, String uniquify(String original)?, String? name}) → InterfaceType -
Registers
sourceon this Module and returns its internal clone.inherited -
addStructuredPairInterface<
InterfaceType extends PairInterface> (InterfaceType source, PairRole role, {String uniquify(String original)?, String? name}) → InterfaceType -
Registers
sourceforroleand returns its internal clone.inherited -
addTypedInOut<
LogicType extends Logic> (String name, LogicType source) → LogicType -
Registers a signal as an inOut to this Module and returns an inOut
port that can be consumed inside this Module. The type of the port will
be
LogicTypeand constructed via Logic.clone, so it is required that thesourceimplements clone functionality that matches the type and properly updates the Logic.name as well. A declared payload must retain its runtime type and recursive shape, including any PayloadShapeMetadata.inherited -
addTypedInput<
LogicType extends Logic> (String name, LogicType source, {bool preserveStructuredConstants = true}) → LogicType -
Registers a signal as an input to this Module and returns an input
port that can be consumed. The type of the port will be
LogicTypeand constructed via Logic.clone, so it is required that thesourceimplements clone functionality that matches the type and properly updates the Logic.name as well. A declared payload must retain its runtime type and recursive shape, including any PayloadShapeMetadata.inherited -
addTypedOutput<
LogicType extends Logic> (String name, LogicType logicGenerator({String name})) → LogicType -
Registers an output to this Module and returns an output port that
can be driven by this Module or consumed outside of it. The type of the
port will be
LogicTypeand constructed vialogicGenerator, which must properly update thenameof the generatedLogicTypeas well.inherited -
build(
) → Future< void> -
Builds the Module and all subModules within it.
inherited
-
dumpSystemVerilog(
{SystemVerilogSynthesizerConfiguration configuration = const SystemVerilogSynthesizerConfiguration()}) → String -
Generates synthesized SystemVerilog for this Module.
inherited
-
dumpWaves(
{String outputPath = 'waves.vcd'}) → WaveformService -
Attaches waveform dumping for this Module to a VCD at
outputPath.inherited -
hierarchy(
) → Iterable< Module> -
Returns an Iterable of Modules representing the hierarchical path to
this Module.
inherited
-
hierarchyString(
[int indent = 0]) → String -
Returns a pretty-print String of the heirarchy of all Modules within
this Module.
inherited
-
inOut(
String name) → Logic -
Accesses the Logic associated with this Modules inOut port
named
name.inherited -
inOutSource(
String name) → Logic -
The original
sourceprovided to the creation of the inOut portnamevia addInOut or addInOutArray.inherited -
input(
String name) → Logic -
Accesses the Logic associated with this Modules input port
named
name.inherited -
inputSource(
String name) → Logic -
The original
sourceprovided to the creation of the input portnamevia addInput or addInputArray.inherited -
isInOut(
Logic signal) → bool -
Returns true iff
signalis the same Logic as the inOut port of this Module with the same name.inherited -
isInput(
Logic signal) → bool -
Returns true iff
signalis the same Logic as the input port of this Module with the same name.inherited -
isOutput(
Logic signal) → bool -
Returns true iff
signalis the same Logic as the output port of this Module with the same name.inherited -
isPort(
Logic signal) → bool -
Returns true iff
signalis the same Logic as an input, output, or inOut port of this Module with the same name.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
output(
String name) → Logic -
Accesses the Logic associated with this Modules output port
named
name.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
tryInOut(
String name) → Logic? -
Provides the inOut named
nameif it exists, otherwisenull.inherited -
tryInput(
String name) → Logic? -
Provides the input named
nameif it exists, otherwisenull.inherited -
tryOutput(
String name) → Logic? -
Provides the output named
nameif it exists, otherwisenull.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited