"""
from nmigen import Elaboratable, Signal, Module, Cat
-cxxsim = False
-if cxxsim:
- from nmigen.sim.cxxsim import Simulator, Settle
-else:
- from nmigen.back.pysim import Simulator, Settle
from nmigen.cli import rtlil
from math import log2
+
from nmutil.iocontrol import PrevControl, NextControl
from soc.fu.base_input_record import CompOpSubsetBase
-from soc.decoder.power_enums import (MicrOp, Function)
-from vcd.gtkw import GTKWSave, GTKWColor
+from nmutil.gtkw import write_gtkw
+from nmutil.sim_tmp_alternative import (Simulator, is_engine_pysim)
class CompFSMOpSubset(CompOpSubsetBase):
super().__init__(layout, name=name)
-
class Dummy:
pass
def __init__(self, width):
self.data = Signal(width, name="p_data_i")
self.shift = Signal(width, name="p_shift_i")
- self.ctx = Dummy() # comply with CompALU API
+ self.ctx = Dummy() # comply with CompALU API
def _get_data(self):
return [self.data, self.shift]
return list(self)
-# Write a formatted GTKWave "save" file
-def write_gtkw_v1(base_name, top_dut_name, loc):
- # hierarchy path, to prepend to signal names
- dut = top_dut_name + "."
- # color styles
- style_input = GTKWColor.orange
- style_output = GTKWColor.yellow
- style_debug = GTKWColor.red
- with open(base_name + ".gtkw", "wt") as gtkw_file:
- gtkw = GTKWSave(gtkw_file)
- gtkw.comment("Auto-generated by " + loc)
- gtkw.dumpfile(base_name + ".vcd")
- # set a reasonable zoom level
- # also, move the marker to an interesting place
- gtkw.zoom_markers(-22.9, 10500000)
- gtkw.trace(dut + "clk")
- # place a comment in the signal names panel
- gtkw.blank("Shifter Demonstration")
- with gtkw.group("prev port"):
- gtkw.trace(dut + "op__sdir", color=style_input)
- # demonstrates using decimal base (default is hex)
- gtkw.trace(dut + "p_data_i[7:0]", color=style_input,
- datafmt='dec')
- gtkw.trace(dut + "p_shift_i[7:0]", color=style_input,
- datafmt='dec')
- gtkw.trace(dut + "p_valid_i", color=style_input)
- gtkw.trace(dut + "p_ready_o", color=style_output)
- with gtkw.group("debug"):
- gtkw.blank("Some debug statements")
- # change the displayed name in the panel
- gtkw.trace("top.zero", alias='zero delay shift',
- color=style_debug)
- gtkw.trace("top.interesting", color=style_debug)
- gtkw.trace("top.test_case", alias="test case", color=style_debug)
- gtkw.trace("top.msg", color=style_debug)
- with gtkw.group("internal"):
- gtkw.trace(dut + "fsm_state")
- gtkw.trace(dut + "count[3:0]")
- gtkw.trace(dut + "shift_reg[7:0]", datafmt='dec')
- with gtkw.group("next port"):
- gtkw.trace(dut + "n_data_o[7:0]", color=style_output,
- datafmt='dec')
- gtkw.trace(dut + "n_valid_o", color=style_output)
- gtkw.trace(dut + "n_ready_i", color=style_input)
-
-
-def write_gtkw(gtkw_name, vcd_name, gtkw_style, gtkw_dom,
- loc=None, zoom=-22.9, marker=-1):
- """ Write a GTKWave document according to the supplied style and DOM.
-
- :param gtkw_name: name of the generated GTKWave document
- :param vcd_name: name of the waveform file
- :param gtkw_style: style for signals, classes and groups
- :param gtkw_dom: DOM style description for the trace pane
- :param loc: source code location to include as a comment
- :param zoom: initial zoom level, in GTKWave format
- :param marker: initial location of a marker
-
- **gtkw_style format**
-
- Syntax: ``{selector: {attribute: value, ...}, ...}``
-
- "selector" can be a signal, class or group
-
- Signal groups propagate most attributes to their children
-
- Attribute choices:
-
- * module: instance path, for prepending to the signal name
- * color: trace color
- * base: numerical base for value display
- * display: alternate text to display in the signal pane
- * comment: comment to display in the signal pane
-
- **gtkw_dom format**
-
- Syntax: ``[signal, (signal, class), (group, [children]), comment, ...]``
-
- The DOM is a list of nodes.
-
- Nodes are signals, signal groups or comments.
-
- * signals are strings, or tuples: ``(signal name, class, class, ...)``
- * signal groups are tuples: ``(group name, class, class, ..., [nodes])``
- * comments are: ``{'comment': 'comment string'}``
-
- In place of a class name, an inline class description can be used.
- ``(signal, {attribute: value, ...}, ...)``
- """
- with open(gtkw_name, "wt") as gtkw_file:
- gtkw = GTKWSave(gtkw_file)
- if loc is not None:
- gtkw.comment("Auto-generated by " + loc)
- gtkw.dumpfile(vcd_name)
- # set a reasonable zoom level
- # also, move the marker to an interesting place
- gtkw.zoom_markers(zoom, marker)
-
- if '' in gtkw_style:
- root_style = gtkw_style['']
- else:
- root_style = dict()
-
- # recursively walk the DOM
- def walk(dom, style):
- for node in dom:
- node_name = None
- children = None
- # copy the style from the parent
- node_style = style.copy()
- # node is a signal name string
- if isinstance(node, str):
- node_name = node
- # node is a tuple
- # could be a signal or a group
- elif isinstance(node, tuple):
- node_name = node[0]
- # collect styles from the selectors
- # order goes from the most specific to most generic
- # which means earlier selectors override later ones
- for selector in reversed(node):
- # update the node style from the selector
- if isinstance(selector, str):
- if selector in gtkw_style:
- node_style.update(gtkw_style[selector])
- # apply an inline style description
- elif isinstance(selector, dict):
- node_style.update(selector)
- # node is a group if it has a child list
- if isinstance(node[-1], list):
- children = node[-1]
- # emit the group delimiters and walk over the child list
- if children is not None:
- gtkw.begin_group(node_name)
- # pass on the group style to its children
- walk(children, node_style)
- gtkw.end_group(node_name)
- # emit a trace, if the node is a signal
- elif node_name is not None:
- signal_name = node_name
- # prepend module name to signal
- if 'module' in node_style:
- signal_name = node_style['module'] + '.' + signal_name
- gtkw.trace(signal_name)
-
- walk(gtkw_dom, root_style)
-
-
def test_shifter():
m = Module()
m.submodules.shf = dut = Shifter(8)
with open("test_shifter.il", "w") as f:
f.write(il)
- # Write the GTKWave project file
- write_gtkw_v1("test_shifter", "top.shf", __file__)
-
- # Describe a GTKWave document
-
- # Style for signals, classes and groups
gtkwave_style = {
- # Root selector. Gives default attributes for every signal.
- '': {'module': 'top.shf', 'base': 'dec'},
- # color the traces, according to class
- # class names are not hardcoded, they are just strings
'in': {'color': 'orange'},
'out': {'color': 'yellow'},
- # signals in the debug group have a common color and module path
- 'debug': {'module': 'top', 'color': 'red'},
- # display a different string replacing the signal name
- 'test_case': {'display': 'test case'},
}
- # DOM style description for the trace pane
gtkwave_desc = [
- # simple signal, without a class
- # even so, it inherits the top-level root attributes
'clk',
- # comment
{'comment': 'Shifter Demonstration'},
- # collapsible signal group
('prev port', [
- # attach a class style for each signal
('op__sdir', 'in'),
('p_data_i[7:0]', 'in'),
('p_shift_i[7:0]', 'in'),
- ('p_valid_i', 'in'),
- ('p_ready_o', 'out'),
- ]),
- # Signals in a signal group inherit the group attributes.
- # In this case, a different module path and color.
- ('debug', [
- {'comment': 'Some debug statements'},
- # inline attributes, instead of a class name
- ('zero', {'display': 'zero delay shift'}),
- 'interesting',
- 'test_case',
- 'msg',
- ]),
+ ({'submodule': 'p'}, [
+ ('p_valid_i', 'in'),
+ ('p_ready_o', 'out')])]),
('internal', [
- 'fsm_state',
+ 'fsm_state' if is_engine_pysim() else 'fsm_state[1:0]',
'count[3:0]',
- 'shift_reg[7:0]',
- ]),
+ 'shift_reg[7:0]']),
('next port', [
('n_data_o[7:0]', 'out'),
- ('n_valid_o', 'out'),
- ('n_ready_i', 'in'),
- ]),
- ]
+ ({'submodule': 'n'}, [
+ ('n_valid_o', 'out'),
+ ('n_ready_i', 'in')])])]
- write_gtkw("test_shifter_v2.gtkw", "test_shifter.vcd",
- gtkwave_style, gtkwave_desc,
- loc=__file__, marker=10500000)
+ write_gtkw("test_shifter.gtkw", "test_shifter.vcd",
+ gtkwave_desc, gtkwave_style,
+ module='top.shf', loc=__file__, base='dec')
sim = Simulator(m)
sim.add_clock(1e-6)
- # demonstrates adding extra debug signal traces
- # they end up in the top module
- #
- zero = Signal() # mark an interesting place
- #
- # demonstrates string traces
- #
- # display a message when the signal is high
- # the low level is just an horizontal line
- interesting = Signal(decoder=lambda v: 'interesting!' if v else '')
- # choose between alternate strings based on numerical value
- test_cases = ['', '13>>2', '3<<4', '21<<0']
- test_case = Signal(8, decoder=lambda v: test_cases[v])
- # hack to display arbitrary strings, like debug statements
- msg = Signal(decoder=lambda _: msg.str)
- msg.str = ''
-
def send(data, shift, direction):
# present input data and assert valid_i
yield dut.p.data_i.data.eq(data)
# wait for p.ready_o to be asserted
while not (yield dut.p.ready_o):
yield
- # show current operation operation
- if direction:
- msg.str = f'{data}>>{shift}'
- else:
- msg.str = f'{data}<<{shift}'
- # force dump of the above message by toggling the
- # underlying signal
- yield msg.eq(0)
- yield msg.eq(1)
# clear input data and negate p.valid_i
yield dut.p.valid_i.eq(0)
yield dut.p.data_i.data.eq(0)
yield dut.n.ready_i.eq(0)
# check result
assert result == expected
- # finish displaying the current operation
- msg.str = ''
- yield msg.eq(0)
- yield msg.eq(1)
def producer():
# 13 >> 2
# 3 << 4
yield from send(3, 4, 0)
# 21 << 0
- # use a debug signal to mark an interesting operation
- # in this case, it is a shift by zero
- yield interesting.eq(1)
yield from send(21, 0, 0)
- yield interesting.eq(0)
def consumer():
# the consumer is not in step with the producer, but the
# order of the results are preserved
# 13 >> 2 = 3
- yield test_case.eq(1)
yield from receive(3)
# 3 << 4 = 48
- yield test_case.eq(2)
yield from receive(48)
# 21 << 0 = 21
- yield test_case.eq(3)
- # you can look for the rising edge of this signal to quickly
- # locate this point in the traces
- yield zero.eq(1)
yield from receive(21)
- yield zero.eq(0)
- yield test_case.eq(0)
sim.add_sync_process(producer)
sim.add_sync_process(consumer)
- sim_writer = sim.write_vcd(
- "test_shifter.vcd",
- # include additional signals in the trace dump
- traces=[zero, interesting, test_case, msg],
- )
+ sim_writer = sim.write_vcd("test_shifter.vcd")
with sim_writer:
sim.run()
projects / soc.git / blobdiff