Makefile accepting arguements, tracefile and output file changed

Author: vtkhatri

.gitignore

@@ -1,6 +1,9 @@
+work/
+transcript
 sim/work
 sim/transcript
 sim/dram
+outs/
 sim/*.wlf
 sim/*.mti
 sim/*.mpf

Makefile

@@ -1,20 +1,53 @@
 # makefile for standard compilation
-.PHONY : queue parser all clean
+.PHONY : all clean VLOG
 
-queue:
-	$(MAKE) -C sim queue
+sim_dir := $(shell pwd)/sim/
+source_dir := $(shell pwd)/hdl/
+traces_dir := $(shell pwd)/traces/
+out_dir := $(shell pwd)/outs/
+sv_files := $(shell find $(source_dir) -name '*.sv')
 
-parser:
-	$(MAKE) -C sim parser
+top_module = "queue_tb"
 
-debug:
-	$(MAKE) -C sim debug
+tracefile = $(traces_dir)/our_tracefiles/trace.txt
+outfile = $(out_dir)/dram
+plus_args := +tracefile=$(tracefile) +outfile=$(outfile)
 
-all:
-	$(MAKE) -C sim all
+silent: VLOG
+	cd $(sim_dir)
+	vsim -c -do "run -all ; q" +nowarn3691 \
+		work.$(top_module) \
+		$(plus_args)
 
-gui:
-	$(MAKE) -C sim gui
+VLIB:
+	cd $(sim_dir)
+	vlib work
+
+VLOG: VLIB
+	cd $(sim_dir)
+	vlog hdl/global_defs.sv
+	vlog $(sv_files)
+
+all: VLOG
+	cd $(sim_dir)
+	vsim -c -do "run -all ; q" +nowarn3691 \
+		work.$(top_module) \
+		+debug_dram +debug_queue +per_clk \
+		$(plus_args)
+
+queue: VLOG
+	cd $(sim_dir)
+	vsim -c -do "run -all ; q" +nowarn3691 \
+		work.$(top_module) \
+		+debug_queue \
+		$(plus_args)
+
+dram: VLOG
+	cd $(sim_dir)
+	vsim -c -do "run -all ; q" +nowarn3691 \
+		work.$(top_module) \
+		+debug_dram \
+		$(plus_args)
 
 clean:
 	echo "why?"

README.md

@@ -1,38 +1,38 @@
-# ECE 585 Fall 2021 Final Project
+# ECE 585 Fall 2021 Final Project Group 12
 
-output dram command trace file - `sim/dram`
+## some things
 
-## build instructions
+* [github repo](https://github.com/vtkhatri/ece585f21_final_project)
+* tracefiles from presentation - `traces/presentation_tracefiles/t*.trace`
+  * output files for these stored in - `outs/t*.out`
+* group tracefiles or checking - `traces/our_tracefiles/*.txt`
 
-```
-make       # just output to sim/dram with minimal prints
-make debug # output to sim/dram and enable all debugging prints
-make dram  # output to sim/dram and enable dram prints
-make queue # output to sim/dram and enable queue prints
-```
+---
 
-## custom tracefile
+To execute all presentation tracefiles use single line command -
 
-for Makefile builds, the `traces/trace.txt` symbolic link is used as the input tracefile.\
-this behavior can be changed in 2 ways -
+```
+for i in {0..13}; do make silent tracefile=$PWD/traces/presentation_tracefiles/t$i.trace outfile=$PWD/outs/t$i.out; done
+```
 
-### changing the symbolic link
+## build instructions
 
-* remove `traces/trace.txt` symbolic link
-* make a new symbolic link
 ```
-cd traces
-ln -s <full_path_to_custom_trace_file> trace.txt
-cd ../sim
-make
+make silent tracefile=<trace_file> outfile=<out_file>
+make all tracefile=<trace_file> outfile=<out_file>    # to get all debug prints, with +per_clk
+make dram tracefile=<trace_file> outfile=<out_file>   # to get dram debug prints only
+make queue tracefile=<trace_file> outfile=<out_file>  # to get queue debug prints only
 ```
-
 ### manually passing as plusarg to vsim command
 
 ```
 cd sim
 vlib work
 vlog ../hdl/global_defs.sv # this is done to ensure package is imported properly
 vlog ../hdl/*.sv
-vsim -c -do "run all ; q" +nowarn3691 work.queue_tb +tracefile=<full_path_to_custom_tracefile>
+vsim -c -do "run all ; q" +nowarn3691 work.queue_tb +tracefile=<trace_file> +outfile=<out_file>
 ```
+
+## report
+
+report is present in `docs/report.md`

hdl/queue.sv

@@ -14,6 +14,11 @@
 
 import global_defs::*;
 
+// we also need filepath with tracefile, so we extrace PWD using getenv function
+// make use of the SystemVerilog C programming interface
+// https://stackoverflow.com/questions/33394999/how-can-i-know-my-current-path-in-system-verilog
+import "DPI-C" function string getenv(input string env_name);
+
 module queue
 (
 	// inputs
@@ -62,7 +67,7 @@ prev_operation_t previous_operation;
 logic output_allowed_normal;
 
 int unsigned dram_file;
-string dram_filename = "dram";
+string dram_filename;
 
 // for access scheduling, checking if current queue entry is inserted
 logic [QUEUE_SIZE-1:0] is_active;
@@ -80,6 +85,12 @@ logic [TIMER_WIDTH-1:0] activate_countup;
 logic [TIMER_WIDTH-1:0] column_countup;
 
 initial begin : dram_file_open
+	if (!$value$plusargs("outfile=%s", dram_filename)) begin
+		dram_filename = {getenv("PWD"), "/../outs/dram"};
+		$display("No output file provided eg. +outfile=<full_path_to_file>");
+		$display("taking output file as default (%s)", dram_filename);
+	end
+
 	dram_file = $fopen(dram_filename, "w");
 	if (dram_file == 0) begin
 		$fatal("Could not open dram output file (%s)", dram_filename);