blob: d4e0d621be6062a7fe281369d9b2db9d53628eaf [file]
#!/usr/bin/env python3
"""
Convert a Verilog simulation model to a VPR `model.xml`
The following Verilog attributes are considered on ports:
- `(* CLOCK *)` : force a given port to be a clock
- `(* ASSOC_CLOCK="RDCLK" *)` : force a port's associated clock to a given value
The following Verilog attributes are considered on modules:
- `(* MODEL_NAME="model" *)` : override the name used for <model> and for
".subckt name" in the BLIF model. Mostly intended for use with w.py, when several
different pb_types implement the same model.
"""
import argparse, re
import os, tempfile, sys
import lxml.etree as ET
import yosys.run
from yosys.json import YosysJson
parser = argparse.ArgumentParser(description=__doc__.strip())
parser.add_argument(
'infiles',
metavar='input.v', type=str, nargs='+',
help="""\
One or more Verilog input files, that will be passed to Yosys internally.
They should be enough to generate a flattened representation of the model,
so that paths through the model can be determined.
""")
parser.add_argument(
'--top',
help="""\
Top level module, will usually be automatically determined from the file name
%.sim.v
""")
parser.add_argument(
'-o',
help="""\
Output filename, default 'model.xml'
""")
args = parser.parse_args()
iname = os.path.basename(args.infiles[0])
aig_json = yosys.run.vlog_to_json(args.infiles, True, True)
if args.top is not None:
yj = YosysJson(aig_json, args.top)
top = yj.top
else:
wm = re.match(r"([A-Za-z0-9_]+)\.sim\.v", iname)
if wm:
top = wm.group(1).upper()
else:
print("ERROR file name not of format %.sim.v ({}), cannot detect top level. Manually specify the top level module using --top").format(iname)
sys.exit(1)
yj = YosysJson(aig_json, top)
if top is None:
print("ERROR: more than one module in design, cannot detect top level. Manually specify the top level module using --top")
sys.exit(1)
xi_url = "http://www.w3.org/2001/XInclude"
ET.register_namespace('xi', xi_url)
xi_include = "{%s}include" % xi_url
def include_xml(parent, href, xptr):
return ET.SubElement(parent, xi_include, {'href': href, 'xpointer': xptr})
tmod = yj.top_module
models_xml = ET.Element("models", nsmap = {'xi': xi_url})
inc_re = re.compile(r'^\s*`include\s+"([^"]+)"')
deps_files = set()
# XML dependencies need to correspond 1:1 with Verilog includes, so we have
# to do this manually rather than using Yosys
with open(args.infiles[0], 'r') as f:
for line in f:
im = inc_re.match(line)
if im:
deps_files.add(im.group(1))
if len(deps_files) > 0:
# Has dependencies, not a leaf model
for df in sorted(deps_files):
module_path = os.path.dirname(df)
module_basename = os.path.basename(df)
wm = re.match(r"([A-Za-z0-9_]+)\.sim\.v", module_basename)
if wm:
model_path = "%s/%s.model.xml" % (module_path, wm.group(1).lower())
else:
assert False
include_xml(models_xml, model_path, "xpointer(models/child::node())")
else:
# Is a leaf model
topname = tmod.attr("MODEL_NAME", top)
model_xml = ET.SubElement(models_xml, "model", {'name': topname})
ports = tmod.ports
inports_xml = ET.SubElement(model_xml, "input_ports")
outports_xml = ET.SubElement(model_xml, "output_ports")
clocks = yosys.run.list_clocks(args.infiles, top)
clk_sigs = dict()
for clk in clocks:
clk_sigs[clk] = yosys.run.get_clock_assoc_signals(args.infiles, top, clk)
for name, width, iodir in ports:
attrs = dict(name=name)
sinks = yosys.run.get_combinational_sinks(args.infiles, top, name)
if len(sinks) > 0 and iodir == "input":
attrs["combinational_sink_ports"] = " ".join(sinks)
if name in clocks:
attrs["is_clock"] = "1"
for clk in clocks:
if name in clk_sigs[clk]:
attrs["clock"] = clk
if iodir == "input":
ET.SubElement(inports_xml, "port", attrs)
elif iodir == "output":
ET.SubElement(outports_xml, "port", attrs)
else:
assert(False) #how does VPR specify inout (only applicable for PACKAGEPIN of an IO primitive)
outfile = "model.xml"
if "o" in args and args.o is not None:
outfile = args.o
f = open(outfile, 'w')
f.write(ET.tostring(models_xml, pretty_print=True).decode('utf-8'))
f.close()
print("Generated {} from {}".format(outfile, iname))