Skip to content

Commit 93da91e

Browse files
skokvermonskokvermon
committed
vivado xsim xci compatibility. compatible with vivado synthesis.
1 parent 573b1f0 commit 93da91e

File tree

5 files changed

+106
-33
lines changed

5 files changed

+106
-33
lines changed

‎edalize/templates/xsim/Makefile.j2‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#Auto generated by Edalize jinja
2+
include config.mk
3+
4+
all: xsim.dir/$(TARGET)/xsimk
5+
6+
# {{ xci_list}}
7+
8+
{%if xci_list %}
9+
xci.prj: xci.tcl
10+
vivado -mode batch -source xci.tcl
11+
cat $(TARGET).prj >> xci.prj
12+
xsim.dir/$(TARGET)/xsimk: $(SRC_FILES) xci.prj
13+
xelab $(TOPLEVEL) -prj xci.prj -snapshot $(TARGET) $(VLOG_DEFINES) $(VLOG_INCLUDES) $(GEN_PARAMS) $(XELAB_OPTIONS) -debug all
14+
{%else%}
15+
xsim.dir/$(TARGET)/xsimk: $(SRC_FILES)
16+
xelab $(TOPLEVEL) -prj $(TARGET).prj -snapshot $(TARGET) $(VLOG_DEFINES) $(VLOG_INCLUDES) $(GEN_PARAMS) $(XELAB_OPTIONS) -debug all
17+
{%endif%}
18+
19+
run: {{ default_run }}
20+
21+
run-dflt: xsim.dir/$(TARGET)/xsimk
22+
xsim -R $(XSIM_OPTIONS) $(TARGET) $(EXTRA_OPTIONS)
23+
24+
run-vcd: xsim.dir/$(TARGET)/xsimk
25+
xsim -t vcd.tcl $(XSIM_OPTIONS) $(TARGET) $(EXTRA_OPTIONS)
26+
27+
run-gui: xsim.dir/$(TARGET)/xsimk
28+
xsim --gui $(XSIM_OPTIONS) $(TARGET) $(EXTRA_OPTIONS)

‎edalize/templates/xsim/config.mk.j2‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#Auto generated by Edalize
2+
TARGET = {{target}}
3+
TOPLEVEL = {{toplevel}}
4+
5+
VLOG_DEFINES = {{vlog_defines}}
6+
VLOG_INCLUDES = {{vlog_includes}}
7+
GEN_PARAMS = {{gen_params}}
8+
9+
XELAB_OPTIONS = {{xelab_options}}
10+
XSIM_OPTIONS = {{xsim_options}}
11+
12+
SRC_FILES={{" ".join(src_list)}}

‎edalize/templates/xsim/xci.tcl.j2‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
create_project -part {{xci_part}} myProject -force
2+
{% for n in xci_list %}
3+
read_ip {{ n }}
4+
{% endfor %}
5+
generate_target simulation [ get_files *.xci ]
6+
#export_simulation -force -simulator xsim -of_objects [get_files *.xci ]
7+
#get_files -all -of_objects [get_files *.xci]
8+
set f [get_files -compile_order sources -used_in simulation -of [get_files *.xci] -quiet]
9+
set fd [ open "xci.prj" "w" ]
10+
foreach d $f {
11+
puts $fd "verilog work $d"
12+
}
13+
close $fd

‎edalize/xsim.py‎

Lines changed: 50 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,41 @@
1212

1313

1414
class Xsim(Edatool):
15+
"""
16+
Vivado Xsim backend
17+
* Standard design sources
18+
* IP: Supply the IP core xci file with file_type=xci and other files (like .prj) as file_type=user .
19+
you also have to specify xilinx part number in tools/xsim/part
1520
16-
argtypes = ["plusarg", "vlogdefine", "vlogparam", "generic"]
17-
18-
MAKEFILE_TEMPLATE = """#Auto generated by Edalize
19-
include config.mk
20-
21-
all: xsim.dir/$(TARGET)/xsimk
22-
23-
xsim.dir/$(TARGET)/xsimk:
24-
xelab $(TOPLEVEL) -prj $(TARGET).prj -snapshot $(TARGET) $(VLOG_DEFINES) $(VLOG_INCLUDES) $(GEN_PARAMS) $(XELAB_OPTIONS)
25-
26-
run: xsim.dir/$(TARGET)/xsimk
27-
xsim -R $(XSIM_OPTIONS) $(TARGET) $(EXTRA_OPTIONS)
21+
* you can also set tools/xsim/default_run to "run_vcd" in order to automatically generate vcd file during simulation
22+
"""
2823

29-
run-gui: xsim.dir/$(TARGET)/xsimk
30-
xsim --gui $(XSIM_OPTIONS) $(TARGET) $(EXTRA_OPTIONS)
31-
"""
32-
33-
CONFIG_MK_TEMPLATE = """#Auto generated by Edalize
34-
TARGET = {target}
35-
TOPLEVEL = {toplevel}
24+
argtypes = ["plusarg", "vlogdefine", "vlogparam", "generic"]
3625

37-
VLOG_DEFINES = {vlog_defines}
38-
VLOG_INCLUDES = {vlog_includes}
39-
GEN_PARAMS = {gen_params}
4026

41-
XELAB_OPTIONS = {xelab_options}
42-
XSIM_OPTIONS = {xsim_options}
27+
VCD_TCL = """#tcl script that runs simulation with vcd output
28+
open_vcd xsim_dump.vcd
29+
log_vcd *
30+
run all
31+
close_vcd
32+
quit
4333
"""
44-
4534
@classmethod
4635
def get_doc(cls, api_ver):
4736
if api_ver == 0:
4837
return {
4938
"description": "XSim simulator from the Xilinx Vivado suite",
5039
"members": [
40+
{
41+
"name": "part",
42+
"type": "String",
43+
"desc": "xilinx part if using xci ip",
44+
},
45+
{
46+
"name": "default_run",
47+
"type": "String",
48+
"desc": "default target to run for makefile. use 'run-vcd' for automatic vcd generation",
49+
},
5150
{
5251
"name": "compilation_mode",
5352
"type": "String",
@@ -81,6 +80,8 @@ def _write_config_files(self):
8180
with open(os.path.join(self.work_root, self.name + ".prj"), "w") as f:
8281
mfcu = []
8382
(src_files, self.incdirs) = self._get_fileset_files()
83+
src_list = []
84+
xci_list = []
8485
for src_file in src_files:
8586
cmd = ""
8687
if src_file.file_type.startswith("verilogSource"):
@@ -96,10 +97,15 @@ def _write_config_files(self):
9697
cmd = "sv"
9798
elif src_file.file_type in ["user"]:
9899
pass
100+
elif src_file.file_type in ["data"]:
101+
os.system("ln -s %s %s"%(src_file.name, os.path.join(self.work_root, os.path.basename(src_file.name))));
102+
elif src_file.file_type in ["xci"]:
103+
xci_list.append(src_file.name)
99104
else:
100105
_s = "{} has unknown file type '{}'"
101106
logger.warning(_s.format(src_file.name, src_file.file_type))
102107
if cmd:
108+
src_list.append(src_file.name)
103109
if src_file.logical_name:
104110
lib = src_file.logical_name
105111
else:
@@ -108,7 +114,7 @@ def _write_config_files(self):
108114
if mfc:
109115
f.write("sv work " + " ".join(mfcu))
110116

111-
with open(os.path.join(self.work_root, "config.mk"), "w") as f:
117+
if 1:
112118
vlog_defines = " ".join(
113119
[
114120
"--define {}={}".format(k, self._param_value_str(v))
@@ -135,20 +141,31 @@ def _write_config_files(self):
135141
xelab_options = " ".join(self.tool_options.get("xelab_options", []))
136142
xsim_options = " ".join(self.tool_options.get("xsim_options", []))
137143

138-
f.write(
139-
self.CONFIG_MK_TEMPLATE.format(
144+
if xci_list:
145+
xci_part = self.tool_options.get("part", "dflt_part")
146+
if xci_part == "dflt_part":
147+
logger.error("When using xci, you must define tools/xsim/part value")
148+
self.render_template("xci.tcl.j2", os.path.join(self.work_root, "xci.tcl"), dict(
149+
xci_list = xci_list,
150+
xci_part = xci_part
151+
))
152+
self.render_template("config.mk.j2", os.path.join(self.work_root, "config.mk"), dict(
140153
target=self.name,
141154
toplevel=self.toplevel,
142155
vlog_defines=vlog_defines,
143156
vlog_includes=vlog_includes,
144157
gen_params=gen_param_args,
145158
xelab_options=xelab_options,
146159
xsim_options=xsim_options,
147-
)
148-
)
149-
150-
with open(os.path.join(self.work_root, "Makefile"), "w") as f:
151-
f.write(self.MAKEFILE_TEMPLATE)
160+
src_list=src_list,
161+
))
162+
163+
self.render_template("Makefile.j2",os.path.join(self.work_root, "Makefile"),dict(
164+
default_run = self.tool_options.get("default_run", "run-dflt"),
165+
xci_list = xci_list
166+
))
167+
with open(os.path.join(self.work_root, "vcd.tcl"), "w") as f:
168+
f.write(self.VCD_TCL)
152169

153170
def run_main(self):
154171
args = ["run"]

‎setup.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ def read(fname):
3939
"templates/ghdl/Makefile.j2",
4040
"templates/openlane/openlane-makefile.j2",
4141
"templates/openlane/openlane-script-tcl.j2",
42+
"templates/xsim/config.mk.j2",
43+
"templates/xsim/Makefile.j2",
44+
"templates/xsim/xci.tcl.j2",
4245
],
4346
"edalize.tools": [
4447
"templates/yosys/edalize_yosys_procs.tcl.j2",

0 commit comments

Comments
 (0)