mg_questasim_templates

#!/usr/bin/env perl

# Script to prepare templates for simulation using Mentor QuestaSim/ModelSim.
#
# This script write files:
#  - Makefile
#  - alias.do
#  - prj_name_tb.sv
#  - wave_prj_name_tb.do
# which may be used for simulation.

#  Time-stamp: <2024-07-02 12:39:30>

use v5.14;
use File::Basename;

sub help {
    my $script_name = basename($0);
    say "Usage:";
    say "  $script_name [project-name] [end-time] [-a]";
    say "ARGS:";
    say "   <project-name>";
    say "            Project name for simulation.";
    say "OPRIONS:";
    say "   end-time";
    say "            End of simulation time(1us, 2ms, etc).";
    say "   -a";
    say "            Add support SystemVerilog Assertion to templates."
}

sub get_from_data_literal {
    my $data = do { undef $/; <DATA>; };
}

sub scalar2arr {
    my @arr = split /\n/, shift;
}

sub template_parser {
    my @data = @_;
    my @all_files = ();
    my %file = ();
    my @fdata = ();
    local $" = "\n";            # list separator
    foreach (@data) {
        if (/__END__/) {
            last;
        }
        if (/FILE_NAME=(.*)/) {
            if (defined $file{'fname'}) { # new File template
                $file{'data'} = "@fdata";
                my %new_file = %file;
                push(@all_files, \%new_file);
            }
            $file{'fname'} = $1;
            @fdata = ();
        } else {
            push @fdata, $_;
        }
    }
    $file{'data'} = "@fdata";
    push(@all_files, \%file);
    return @all_files;
}

sub write2file {
    my ($fname, @data) = @_;
    if (-e $fname) {
        print("Warning! File '$fname' already exist!\n");
        $fname = $fname.-$$;
    }
    my $fh;
    open($fh, ">", $fname) or die "Can't open file: '$fname' to write. $!\n";
    print "Write file: $fname\n";
    foreach (@data) {
        print $fh $_;
    }
    close($fh);
}

sub replace_in_array {
    my $rarr = shift;
    my $rmask = shift;

    foreach my $i (@{$rmask}) {
        my ($x, $y) = (@{$i}[0], @{$i}[1]);
        foreach (@{$rarr}) {
            s/$x/$y/;
        }
    }
}

{
    # Get input arguments
    do {help(); exit} if (@ARGV < 1 or @ARGV > 3);

    my $end_time = undef;
    my $prj_name = undef;
    my $sva_req = 0;

    while (@ARGV) {
        $_ = shift;
        if (/^[a-zA-Z]\w+$/) {$prj_name = $_; next};
        if (/^[0-9]+(.[0-9]+)?[fpnum]?s$/) {$end_time = $_; next};
        if (/^[0-9]+\ws$/) {$end_time = $_; next};
        if (/^-a$/) {$sva_req = 1; next};
        if (/^(-h|--help)$/) {help(); exit};
        do {say "ERROR! Unknown argument: $_"; help(); exit}
    }
    do {help(); exit} unless defined $prj_name;
    $end_time = '1us' unless defined $end_time;
    print "Project-name: $prj_name; End-time: $end_time; SVA: $sva_req;\n";

    # Prepare templates
    my $end2wave = ($end_time =~ s/([0-9]+)/$1 /r);
    $end2wave =~ s/([0-9]+)/($1*1.05)/e;

    my @mask = ();
    if ($sva_req) {
        push(@mask, ["1ns/1ps",
                     "1ns/1ps -assertdebug"]);
        push(@mask, ["VSIM_OPTIONS =",
                     "VSIM_OPTIONS = -msgmode both -assertdebug -immedassert -psl -sva"]);
        push(@mask, ["vsim PRJNAME_tb_opt",
                     "vsim PRJNAME_tb_opt -msgmode both -assertdebug -immedassert -psl -sva"]);
    }
    push(@mask, ["PRJNAME", $prj_name]);
    push(@mask, ["ENDTIME", $end_time]);
    push(@mask, ["ENDINWAVE", $end2wave]);

    my $templates = get_from_data_literal;
    my @templates = scalar2arr($templates);
    replace_in_array(\@templates, \@mask);

    # Write template files
    my @files = template_parser(@templates);
    foreach (@files) {
        my $href = $_;
        my ($fname, @data) = ($href->{fname}, $href->{data});
        write2file($fname, @data);
    }
}

__DATA__
FILE_NAME=alias.do
alias run_PRJNAME {
    make compile
    make opt
    vsim PRJNAME_tb_opt
    view wave
    do wave_PRJNAME_tb.do
    onfinish stop
    run ENDTIME
    wave zoom full
}

alias h {
    echo "   h                   - List of all user's aliases"
    echo "   run_PRJNAME - Run simulation"
}

echo "Added user aliases:"
h

FILE_NAME=wave_PRJNAME_tb.do
onerror {resume}
quietly WaveActivateNextPane {} 0
# -----------------------------------------------------------------------------------------------

add wave -noupdate -divider TB
add wave /PRJNAME_tb/tb_status
add wave -noupdate -radix hexadecimal /PRJNAME_tb/*

# ----------------------------------------------------------------------------------------------
quietly WaveActivateNextPane

add wave -noupdate -divider DUT
add wave -noupdate -radix hexadecimal /PRJNAME_tb/dut/*

# -----------------------------------------------------------------------------------------------
TreeUpdate [SetDefaultTree]
WaveRestoreCursors {{Cursor 1} {1 us} 0}
quietly wave cursor active 1
configure wave -namecolwidth 179
configure wave -valuecolwidth 60
configure wave -justifyvalue left
configure wave -signalnamewidth 1
configure wave -snapdistance 10
configure wave -datasetprefix 0
configure wave -rowmargin 4
configure wave -childrowmargin 2
configure wave -gridoffset 0
configure wave -gridperiod 1
configure wave -griddelta 40
configure wave -timeline 0
configure wave -timelineunits ns
update
# End cotime = 105% simulation time
WaveRestoreZoom {0 ps} {ENDINWAVE}
wave zoom full

FILE_NAME=Makefile

MAKE = make --no-print-directory

QUIET_OPTION = -quiet
SCHEMATIC_OPTION = -debugdb

VLOG = vlog -incr -sv +acc -timescale 1ns/1ps $(QUIET_OPTION)
VOPT = vopt $(SCHEMATIC_OPTION) $(QUIET_OPTION)

VSIM_MODE ?= "-c"
END_TIME_VSIM ?= ENDTIME

VSIM = $(if $(findstring -c,$(VSIM_MODE)),\
vsim -c $(QUIET_OPTION) $(DUT)_tb_opt -do "run $(END_TIME_VSIM); exit",\
vsim -gui $(QUIET_OPTION) $(SCHEMATIC_OPTION) $(DUT)_tb_opt -do "source ./wave_$(DUT)_tb.do; onfinish stop; run $(END_TIME_VSIM); wave zoom full;" &)

.PHONY: h compile_rtl compile_tb compile opt sim all rall clean
h:
	@echo ""
	@echo "Usage:  make [target(s)]"
	@echo "where target is any of:"
	@echo ""
	@echo "  all         - compilation, optimization, simulation DUT project"
	@echo "  rall        - run 'clean' and 'all' target"
	@echo "  compile_rtl - compile all rtl"
	@echo "  compile_tb  - compile all testbench"
	@echo "  compile     - compile all rtl and testbench"
	@echo "  opt         - optimization project"
	@echo "  sim         - run simulation project (set VSIM_MODE=-c to Command line mode)"
	@echo "  clean       - remove derived files"
	@echo ""

DUT = PRJNAME
LIBS =
RTL = ../

compile_rtl:
	@echo "Compiling the RTL..."
	@$(VLOG) $(LIBS) $(RTL)/$(DUT).sv

compile_tb:
	@echo "Compiling the TB..."
	@$(VLOG) ./$(DUT)_tb.sv

compile:
	@$(MAKE) compile_rtl
	@$(MAKE) compile_tb

opt@:
	@echo "Optimizing the TB..."
	@$(VOPT) $(DUT)_tb $(LIBS) -o $(DUT)_tb_opt

sim@:
	@echo "Running simulation..."
	@$(VSIM)

all:
	@$(MAKE) compile
	@$(MAKE) opt
	@$(MAKE) sim

rall:
	@$(MAKE) clean
	@$(MAKE) all

clean:
	@echo "Cleaning derived files..."
	@rm -rf *~ work *.wlf* questa.tops transcript *.vstf wlft??????

FILE_NAME=PRJNAME_tb.sv
`define MSG(msg) \
	tb_status = msg; \
	$display("%0t, %s", $time, msg);

module PRJNAME_tb;

string tb_status;

logic clk;
logic rst;

PRJNAME dut(.*);

`define CLK125 8ns
initial begin
	clk = 0;
	forever #(`CLK125/2) clk = ~clk;
end

initial begin
	rst = 1;
	`MSG("Reset")
	repeat (10) @(posedge clk);
	rst = 0;
	`MSG("Idle")
end

endmodule

__END__

#  This is for the sake of Emacs.
#  Local Variables:
#  time-stamp-end: "$"
#  time-stamp-format: "<%:y-%02m-%02d %02H:%02M:%02S>"
#  time-stamp-start: "Time-stamp: "
#  End: