rvvm 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382560e4ccb96972c0588cb6e5bcfd1bc70e6270349ef8db3e156a86ae247507
-  data.tar.gz: 9a29c17cdf2496336b01767c9e9de74c451094fd4c8af361fc3f2d1c1a1c17a6
+  metadata.gz: 87bb2df32ddefc3b2a60a2ab3a2a16f06ab99e7a7e87b7f4a6b0b5397cc653de
+  data.tar.gz: '0205778de7b899092c54f2a0df6552294e50c25e6a213af1d17c47de30659a20'
 SHA512:
-  metadata.gz: 380692384df76a75b6099f1d395721162a10c30070fc2f678b07684379debe8e9f15d503ff2a0ff2a64fe116f395808378796313a2bebb806d6c6992d6dcf4f7
-  data.tar.gz: d15065c6eedba2aaf550d93f31f42e5717691a47355a0820b4366cfeb81034386641b771ca7e30a64e2c931843516d22ff2f8df25e628ecab82ce377d172c7c8
+  metadata.gz: 653bfc3de532ba3180787beaa378c143a90c22e1cd36a029b991523d83766c71c97d38a04af3714ee705234b2b2af880218edc050dcd6926d78d54851218fccd
+  data.tar.gz: caa9ab4d9ac09af338527577c7dc8885eeaa2569f03994d7e6c896c7ebfcd3a54ef649ff59f048d6e056608ba48f0d0ab266b040ef08cb2f319af0ef9f377120

data/CHANGELOG.md

@@ -17,6 +17,7 @@
 7. UVM test simulation
 
 ### TBI:
+
 1. Test list parsing and batch simulation
 2. Module/itf/pkg/generic sv template generation
 3. Pure SV/Vlog simulation
@@ -25,3 +26,25 @@
 6. Unit tests
 7. CLI log graphic
 
+## [0.9.0] - 2024-09016
+
+### Added:
+
+1. Pure SV/Vlog simulation
+2. Waveform inspection in Vivado GUI
+3. SV module/itf/pkg and generic SV file template generation
+4. Functional covevrage report generation
+5. Coverage report inspection in Xilinx coverage dashboard
+6. List of required arguments in --help
+
+### Fixes:
+
+1. Compilation, elaboration and simulation log path
+2. Crash on project config load failure
+3. Updated help and README
+
+### TBI:
+
+1. Test list parsing and batch simulation
+2. Unit tests
+3. CLI log graphics

data/README.md

@@ -18,7 +18,50 @@ gem install rvvm
 
 ## Usage
 
-TBA
+### Project management
+
+Create a new RVvM project using `-n` or `--new`.
+
+eg.:
+```
+rvvm -n best_rtl_project
+```
+
+Whitespaces in project name and or generated templates are not allowed.
+
+To manage an RVvM project use the `rvvm` script from inside an RVvM project root or its config directory.
+
+#### Project structure
+
+```
+RvvM_project
+├── design              # SV design sources
+│   ├── itf
+│   ├── pkg
+│   └── src
+├── rvvm                # RVvM project config and output directory
+│   ├── rvvm_project_compile_list.f
+│   ├── dpi_compile_list.f
+│   ├── logs            # comp, dpi, elab, sim log dir
+│   │   ├── comp
+│   │   ├── dpi
+│   │   ├── elab
+│   │   └── sim
+│   ├── rvvmconf.json   # RVvM project config file
+│   └── wfcfg.tcl
+└── verif               # SV verification sources
+    ├── env
+    │   ├── agents
+    │   └── top
+    ├── tb
+    │   └── src         # default UVM testbench top module
+    │       └── rvvm_project_tb_top.sv
+    └── test
+        ├── seq
+        └── src
+```
+
+To get full `rvvm` usage docs use `-h` or `--help` option.
 
 ## Development
 
@@ -28,7 +71,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/such-hdl-much-wow/rvvm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/such-hdl-much-wow/rvvm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
 
 ## License
 
@@ -36,5 +79,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rvm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
+Everyone interacting in the RVvM project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/such-hdl-much-wow/rvvm/-/blob/master/CODE_OF_CONDUCT.md?ref_type=heads).
 

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rvvm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rvvm/utils.rb

@@ -1,4 +1,4 @@
-# # frozen_string_literal: true
+# frozen_string_literal: true
 
 module Utils
   def self.interpret(string, hash)

data/lib/rvvm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rvvm
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/rvvm.rb

@@ -17,6 +17,7 @@ module Rvvm
 
   @args = {}
   @required_args = %i[
+    version
     new
     module
     pkg
@@ -39,14 +40,25 @@ module Rvvm
       puts "\tRVvM is a Ruby based tool to manage, compile, elaborate and simulate SystemVerilog and UVM based projects"
       puts "\tusing Xilinx Vivado xvlog, xelab, xrun and xsc.\n\n"
       puts args
+
+      @current_time = Time.now
+      @formatted_time = @current_time.strftime("%Y-%m-%d %H:%M:%S")
+
+
+      req_args = String.new
+      @required_args.each do |arg|
+        req_args << "--#{arg} "
+      end
+      puts "\nRequired args (at least one): #{req_args}\n\n"
       # puts "\nRequired args (at least one):"
       # @required_args.each do |arg|
       #   puts "\t--#{arg}"
       # end
-      exit
+      exit(0)
     end
     args.on("-v", "--version", "Displays RVvM gem version") do
-      puts "RVvM version: #{VERSION}"
+      puts "\nRVvM version: #{VERSION}\n\n"
+      exit(0)
     end
 
     args.on("-n", "--new NAME", "Creates a new project wit the prowided name under pwd")
@@ -54,12 +66,12 @@ module Rvvm
     args.on("--pkg NAME", "Creates a SystemVerilog package template (default path: <prj dir>/design/pkg)")
     args.on("--itf NAME", "Creates a SystemVerilog interface template (default path: <prj dir>/design/itf)")
     args.on("--svfile NAME", "Creates a generic SystemVerilog file template (default path: <prj dir>/design/src)")
-    args.on("--here", "Speciies pwd as a path when creating a file template")
+    # args.on("--here", "Speciies pwd as a path when creating a file template")
     args.on("--path PATH", "Specifies a path relative to <prj dir> when creating a file template")
     args.on("-c", "--comp", "Compile SystemVerilog sources")
     args.on("-e", "--elab", "Elaborates project")
     args.on("-r", "--run", "Runs UVM simulation")
-    args.on("-a", "--all", "Runs --comp, (--dpi), --elab, --run")
+    args.on("-a", "--all", "Runs --comp, --dpi if --dpilib or configured in rvvmconf, --elab, --run")
     args.on("--runsv", "Runs pure SystemVerilog/Verilog simulation (Ignores UVM related arguments and config options)")
     args.on("-d", "--dpi", "Compiles C/C++ sources to a shared lib to link into an elaborated snaphost using DPI-C")
     args.on("-u", "--gui", "Opens a dumped waveform in Xilinx Vivado GUI")
@@ -208,7 +220,7 @@ module Rvvm
 
   def self.compile
     cmd_args = @config[:compilation][:args]
-    logname = File.join(@config[:compilation][:logDir], @args[:complog] || @config[:compilation][:log])
+    logname = @args[:complog] || File.join([@config[:project][:logDir], @config[:compilation][:logDir], @config[:compilation][:log]])
     complist = @args[:compilelist] || @config[:compilation][:list]
 
     puts "\nRVvM: Compiling HDL sources..\n"
@@ -231,7 +243,7 @@ module Rvvm
     cmd_args = @config[:elaboration][:args]
     cmd_args << " -sv_lib dpi" if @args[:dpi] || @args[:dpilib] || @config[:dpi][:dpilib] == 1
     cmd_args << " -debug wave" if @args[:wave]
-    logname = File.join(@config[:elaboration][:logDir], @args[:elablog] || @config[:elaboration][:log])
+    logname = @args[:elablog] || File.join([@config[:project][:logDir], @config[:elaboration][:logDir], @config[:elaboration][:log]])
     tb_top = @args[:tbtop] || @config[:elaboration][:tbTop]
     tb = @args[:tb] || @config[:elaboration][:tb]
     timescale = @args[:timescale] || @config[:elaboration][:timescale]
@@ -263,7 +275,7 @@ module Rvvm
     testlist.each_with_index do |simtest, i|
       puts "RVvM: Running test #{i + 1}/#{testlist.size}: #{simtest}"
 
-      logname = File.join(@config[:simulation][:logDir], @config[:simulation][:log])
+      logname = File.join([@config[:project][:logDir], @config[:simulation][:logDir], @config[:simulation][:log]])
       logname = Utils.interpret(logname, { testname: simtest })
 
       verb = "UVM_#{@args[:verb] || @config[:simulation][:verbosity]}"
@@ -273,6 +285,82 @@ module Rvvm
     end
   end
 
+  def self.run_sv
+    cmd_args = @config[:simulation][:args]
+    tb = @args[:simtb] || @args[:tb] || @config[:elaboration][:tb]
+
+    puts "\nRVvM: Running pure SV/V simulation..."
+    logname = @args[:simlog] || File.join([@config[:project][:logDir], @config[:simulation][:logDir], "svsim.log"])
+
+    cmd = "xsim #{tb} -log #{logname} #{cmd_args}"
+    execute(cmd)
+  end
+
+  def self.gui
+    dump = @args[:wavefile] || "#{@config[:elaboration][:tb]}.wdb"
+
+    cmd = "xsim --gui #{dump}"
+    execute(cmd)
+  end
+
+  def self.coverage
+    cmd = "xcrg -report_format html -dir xsim.covdb"
+    execute(cmd)
+  end
+
+  def self.cov_report
+    Dir.chdir("xcrg_func_cov_report")
+    execute("./dashboard.html")
+  end
+
+  def self.create_module(type, name)
+    conf = @templates[:module][:conf]
+    conf[:module] = name
+    conf[:date] = @formatted_time
+    conf[:prjname] = @config[:project][:name]
+    conf[:company] = @config[:project][:company]
+
+    conf[:type] = type
+    @templates[:module][:file][:path] = "design/itf" if type == "itf"
+    path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+    conf[:username] = Utils.git_userame || " "
+
+    Utils.gen_template(@templates[:module], "#{name}.sv", conf, path)
+
+    exit(0)
+  end
+
+  def self.create_pkg(name)
+    conf = @templates[:package][:conf]
+    conf[:package] = name
+    conf[:PACKAGE] = name.upcase
+    conf[:date] = @formatted_time
+    conf[:prjname] = @config[:project][:name]
+    conf[:company] = @config[:project][:company]
+    conf[:username] = Utils.git_userame || " "
+
+    path = File.join([@config[:project][:path], @args[:path] || @templates[:package][:file][:path]])
+
+    Utils.gen_template(@templates[:package], "#{name}.sv", conf, path)
+
+    exit(0)
+  end
+
+  def self.create_svfile(name)
+    conf = @templates[:svfile][:conf]
+    conf[:NAME] = name.upcase
+    conf[:date] = @formatted_time
+    conf[:prjname] = @config[:project][:name]
+    conf[:company] = @config[:project][:company]
+    conf[:username] = Utils.git_userame || ""
+
+    path = File.join([@config[:project][:path], @args[:path] || @templates[:package][:file][:path]])
+
+    Utils.gen_template(@templates[:svfile], "#{name}.sv", conf, path)
+
+    exit(0)
+  end
+
   def self.run
     create_new_project(@args[:new]) if @args[:new]
 
@@ -280,12 +368,22 @@ module Rvvm
     load_config
     handle_args
 
+    create_module(@args[:module], nil)  if @args[:module]
+    create_module(@args[:itf, "itf"])   if @args[:itf]
+    create_pkg(@args[:pkg])             if @args[:pkg]
+    create_svfile(@args[:svfile])       if @args[:svfile]
+
     prj_top
 
     compile     if @args[:comp]
     dpi_c       if @args[:dpi]
     elaborate   if @args[:elab]
     run_sim     if @args[:run]
+    run_sv      if @args[:runsv]
+    gui         if @args[:gui]
+    coverage    if @args[:gencov]
+    cov_report  if @args[:covreport]
+
+    exit(0)
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rvvm
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - mrbya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-15 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies: []
 description: RVvM is a Ruby based meta tool to manage/compile/elaborate and run simulations
   on SystemVerilog and UVM based projects using Xilinx Vivado xvlog, xelab, xrun,
@@ -25,6 +25,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/rvvm.rb
 - lib/rvvm/templates.rb
 - lib/rvvm/utils.rb