From 30d54a6851b511b017070619f67141e0fb927e22 Mon Sep 17 00:00:00 2001
From: abejgonzalez <abe.j.gonza@gmail.com>
Date: Mon, 20 May 2019 17:12:22 -0700
Subject: [PATCH] readme addition | pipe out output | renamed output files

---
 README.md             | 10 ++++++++++
 common.mk             |  2 +-
 sims/verisim/Makefile |  2 +-
 sims/vsim/Makefile    |  2 +-
 variables.mk          |  3 ++-
 5 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 9e2b31fa..a4ef1c81 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,16 @@ build an alternate configuration.
     make PROJECT=yourproject CONFIG=YourConfig
     ./simulator-yourproject-YourConfig ...
 
+Additionally, you can use a helper make rule to run your simulation binary. The output will be in the "verisim"
+directory under the file names: `<binary-name>.<type of project/config/etc it ran on>.*`
+
+    # first make your verisim rtl simulator binary
+    make SUB_PROJECT=example
+    # then run the binary (with no vcd generation)
+    make SUB_PROJECT=example BINARY=<my-riscv-binary> run-binary
+    # then run the binary (with vcd generation)
+    make SUB_PROJECT=example BINARY=<my-riscv-binary> run-binary-debug
+
 ## Submodules and Subdirectories
 
 The submodules and subdirectories for the project template are organized as
diff --git a/common.mk b/common.mk
index 2136080b..b6519df0 100644
--- a/common.mk
+++ b/common.mk
@@ -71,7 +71,7 @@ verilog: $(sim_vsrcs)
 # helper rules to run simulator
 #########################################################################################
 run-binary: $(sim)
-	$(sim) $(PERMISSIVEON) $(SIM_FLAGS) $(PERMISSIVEOFF) $(BINARY)
+	$(sim) $(PERMISSIVEON) $(SIM_FLAGS) $(PERMISSIVEOFF) $(BINARY) 3>&1 1>&2 2>&3 | spike-dasm > $(sim_out_name).out
 
 #########################################################################################
 # run assembly/benchmarks rules
diff --git a/sims/verisim/Makefile b/sims/verisim/Makefile
index 35a36369..9264b43f 100644
--- a/sims/verisim/Makefile
+++ b/sims/verisim/Makefile
@@ -84,7 +84,7 @@ $(sim_debug): $(model_mk_debug)
 # helper rules to run simulator with debug
 #########################################################################################
 run-binary-debug: $(sim_debug)
-	$(sim_debug) $(SIM_FLAGS) -v$(long_name).vcd $(BINARY)
+	$(sim_debug) $(SIM_FLAGS) -v$(sim_out_name).vcd $(BINARY) 3>&1 1>&2 2>&3 | spike-dasm > $(sim_out_name).out
 
 #########################################################################################
 # create a verisim vpd rule
diff --git a/sims/vsim/Makefile b/sims/vsim/Makefile
index 9931bc03..a9edcdc5 100644
--- a/sims/vsim/Makefile
+++ b/sims/vsim/Makefile
@@ -90,7 +90,7 @@ $(sim_debug) : $(sim_vsrcs) $(sim_dotf)
 # helper rules to run simulator with debug
 #########################################################################################
 run-binary-debug: $(sim_debug)
-	$(sim_debug) $(PERMISSIVEON) $(SIM_FLAGS) +vcdplusfile=$(long_name).vpd $(PERMISSIVEOFF) $(BINARY)
+	$(sim_debug) $(PERMISSIVEON) $(SIM_FLAGS) +vcdplusfile=$(sim_out_name).vpd $(PERMISSIVEOFF) $(BINARY) 3>&1 1>&2 2>&3 | spike-dasm > $(sim_out_name).out
 
 #########################################################################################
 # create a vcs vpd rule
diff --git a/variables.mk b/variables.mk
index 22efd535..dfc9d9fa 100644
--- a/variables.mk
+++ b/variables.mk
@@ -143,8 +143,9 @@ output_dir=$(sim_dir)/output/$(long_name)
 #########################################################################################
 # helper variables to run binaries
 #########################################################################################
-BINARY ?= none
+BINARY ?=
 SIM_FLAGS ?= +verbose
+sim_out_name = $(notdir $(basename $(BINARY))).$(long_name)
 
 #########################################################################################
 # build output directory for compilation