rvvm 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420096b77b4d823c6ad6a69509ffe6da56d4a63cf96152cd7d36a5ea41ab063a
-  data.tar.gz: 28b2c65e701d7f2bdfdb3b7bac2d0d7a9f62db9877d912d18eaa9a8e8d9aac78
+  metadata.gz: bdb2b96ce09d030dc59c5bc426673d5208aaba4ce8aa4b097179d62cdaa2dc17
+  data.tar.gz: 37576dcfb35c64353383518a8c8ef496e4930a76acd2f3ba3bcfb3dcb45e4a1a
 SHA512:
-  metadata.gz: b2cb584479a4fde2453c4d4830403db857d2dc197840dc44dd2b9b932881e111abea00fbad1ba52e7c2e01e4865b66911f12eef5110bdadb695a468df293aeb8
-  data.tar.gz: eea11a1a5f36f0a20d796dd87e165f7618b022c8062c81b0eb45122644a5291adcbd475973df785008bc3e43be866b3b78830bcb3c666636b17a03b138cde830
+  metadata.gz: af7c4f03fd70b8eca2f5da78d0e02d67d777aa04d95b166c07f7fe625ba46ae053141e4e7664d352fc2e02c95c11a30ba3501a87cfcbaa00f8ba7bd51dcee1aa
+  data.tar.gz: b0c520fae9157b3d6a20593b0d3ed44baff1c967d734ebe6e1012c58fca1d71c63a218550f64a88aed8232d75bb49cb41b70c58b1967b30fc38a1a73fa5799c7

data/CHANGELOG.md

@@ -156,7 +156,6 @@
 ## TBI:
 
 1. Elaboration and simulation custom waveform trace dump file
-2. Project template files regeneration/restoration to default
 3. Crayon module tests
 4. RBS definitions
 
@@ -171,3 +170,26 @@
 ### Fixed:
 
 1. More Crayons rendering bugs
+
+## [1.2.0] - 2024-09-19
+
+### Added:
+
+1. Cyayons.command exception handling
+2. Flags for itf, pkg and svfile template generation
+3. Custom DPI-C library for elaboration
+
+### Fixed
+
+1. More rendering bugs
+2. Package template not being generated under <prj root>/design/pkg by default
+3. DPI-C compilation using invalid command
+4. Script crash on trying to execute a missing shell command
+5. Script crashing on trying to open non existent coverage report
+
+### TBI
+
+1. Custom waveform dump file name for elaboration and simulation
+2. RVvM config file versions and regeneration
+3. Exit on failing compilation/elaboration/simulation
+

data/lib/rvvm/crayons.rb

@@ -85,7 +85,6 @@ module Crayons
 
     print "\r\e[K"
     @thread_paused = true
-    sleep(0.1)
     print "\r\e[K"
   end
 
@@ -109,11 +108,11 @@ module Crayons
   def self.spinner_stop(message = nil, exit)
     return unless @spinner_running
 
+    sleep(0.1)
     spinner_message = message || (exit ? "Done!" : "Failed!")
     exit ? @spinner.success(spinner_message.green) : @spinner.error(spinner_message.red)
     @thread.join
     @spinner_running = false
-    print "\r\e[K"
   end
 
   # Logs a message during spinner execution removing the need
@@ -146,6 +145,12 @@ module Crayons
     spinner_log("#{out.out}\n")
     spinner_stop(nil, out.success?)
     puts ""
+  rescue Errno::ENOENT
+    spinner_stop(nil, false)
+    log_error("\nError: #{cmd.split.first} not found!\n")
+  rescue StandardError => e
+    spinner_stop(nil, false)
+    log_error("\nAn unexpected error ocurred:\n\n#{e.message}\n")
   end
 
   # Logs a green text message to stdout.

data/lib/rvvm/templates.rb

@@ -39,6 +39,7 @@ module Templates
     "tbTop": "${prjname}_tb_top",
     "tb": "${prjname}_tb",
     "timescale": "1ns/1ps",
+    "customdpilib": "",
     "logDir": "elab",
     "log": "elab.log",
     "args": " "

data/lib/rvvm/version.rb

@@ -3,5 +3,5 @@
 # Module holding current rvvm version.
 module Rvvm
   # Current rvvm module version.
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/rvvm.rb

@@ -75,38 +75,39 @@ module Rvvm
       exit(0)
     end
 
-    args.on("-n", "--new NAME", "Creates a new project wit the prowided name under pwd")
-    args.on("-m", "--module NAME", "Creates a SystemVerilog module template (default path: <prj dir>/design/src)")
-    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("--path PATH", "Specifies a path relative to <prj dir> when creating a file template")
+    args.on("-n", "--new <NAME>", "Creates a new project wit the prowided name under pwd")
+    args.on("-m", "--module <NAME>", "Creates a SystemVerilog module template (default path: <prj root>/design/src)")
+    args.on("-p", "--pkg <NAME>", "Creates a SystemVerilog package template (default path: <prj root>/design/pkg)")
+    args.on("-i", "--itf <NAME>", "Creates a SystemVerilog interface template (default path: <prj root>/design/itf)")
+    args.on("-s", "--svfile <NAME>", "Creates a generic SystemVerilog file template (default path: <prj root>/design/src)")
+    args.on("--path <PATH>", "Specifies a path relative to <prj dir> when creating a file template")
     args.on("--here", "Specifies pwd as the path for template file creation.")
     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 if --dpilib or configured in rvvmconf, --elab, --run")
+    args.on("-a", "--all", "Runs --comp, --dpi if dpi dpilib 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")
     args.on("-g", "--gencov", "Generates a functional coverage report")
-    args.on("-p", "--covreport", "Opens the latest generated functional coverage report in Xilinx coverage dashboard")
-    args.on("--complog LOGNAME", "Specifies compilation log filename (overrides config)")
-    args.on("--complist LISTFILE", "Specifies compile list for compilation (overrides config)")
-    args.on("--elablog LOGNAME", "Specifies elaboration log filename (overrides config)")
-    args.on("--timescale TIMESCALE", "Specifies timescale for testbench snapshot to be elaborated (overrides config)")
-    args.on("--tbtop TOPMODULE", "Specifie testbench top module (overwrites config)")
-    args.on("--tb TBNAME", "Specifies tesbench snapshot to be elaborated (overwrites config)")
-    args.on("--simlog LOGNAME", "Specifies simulation log name (overwrites config)")
-    args.on("--test TESTNAME", "Specifies UVM test to be run by --run (overwrites config)")
+    args.on("--covreport", "Opens the latest generated functional coverage report in Xilinx coverage dashboard")
+    args.on("--complog <LOGNAME>", "Specifies compilation log filename (overrides config)")
+    args.on("--complist <LISTFILE>", "Specifies compile list for compilation (overrides config)")
+    args.on("--elablog <LOGNAME>", "Specifies elaboration log filename (overrides config)")
+    args.on("--timescale <TIMESCALE>", "Specifies timescale for testbench snapshot to be elaborated (overrides config)")
+    args.on("--tbtop <TOPMODULE>", "Specifie testbench top module (overwrites config)")
+    args.on("--tb <TBNAME>", "Specifies tesbench snapshot to be elaborated (overwrites config)")
+    args.on("--customdpilib <PATH>", "Specifies a custom DPI-C library to link into a snapshot to be elaborated (overwrites config)")
+    args.on("--simlog <LOGNAME>", "Specifies simulation log name (overwrites config)")
+    args.on("--test <TESTNAME>", "Specifies UVM test to be run by --run (overwrites config)")
     args.on("-b", "--batch", "Run a batch of UVM tests from a test list (overwrites config)")
-    args.on("--testlist TESTLIST", Array, "Specifies test list as a comma separated string for a batch of test run (overwrites config)")
-    args.on("--verb VERBOSITY", "Specifies UVM verbosity <LOW, MEDIUM, HIGH, FULL, DEBUG> (overwrites config)")
-    args.on("--simtb TBNAME", "Specifies testbench snapshot for simulation (overwrites config)")
-    args.on("--dpilist LISTFILE", "Specifies source file list for DPI-C compilation (overwrites config)")
+    args.on("--testlist \"<TESTLIST>\"", Array, "Specifies test list as a comma separated string for a batch of test run (overwrites config)")
+    args.on("--verb <VERBOSITY>", "Specifies UVM verbosity <LOW, MEDIUM, HIGH, FULL, DEBUG> (overwrites config)")
+    args.on("--simtb <TBNAME>", "Specifies testbench snapshot for simulation (overwrites config)")
+    args.on("--dpilist <LISTFILE>", "Specifies source file list for DPI-C compilation (overwrites config)")
     args.on("-w", "--wave", "Activates waveform trace dump for elaboration and simulation (overwrites config)")
-    args.on("--wavefile WAVEFILE", "Specifies waveform dump file to be openned in Vivado GUI")
-    args.on("--prjconf CONFIG", "Specifies RVvM project config file if not using the one provided in the project")
+    args.on("--wavefile <WAVEFILE>", "Specifies waveform dump file to be openned in Vivado GUI")
+    args.on("--prjconf <CONFIG>", "Specifies RVvM project config file if not using the one provided in the project")
     args.on("-l", "--dpilib", "Specifies a DPI-C shared library to be linked with a snapshot during elaboration")
     args.on("--debug", "Script debug")
   end.parse!(into: @args)
@@ -150,6 +151,8 @@ module Rvvm
       puts "UVM test list provided without running in batch mode - option will be ignored..."
       @args[:testlist] = nil
     end
+
+    @config[:elaboration][:customdpilib] = @args[:customdpilib] if @args[:customdpilib]
   end
 
   # Shell command with debug printout.
@@ -164,9 +167,9 @@ module Rvvm
   # @since 0.8.0
   def self.execute(tag, command)
     if @args[:debug]
-      puts command
       Crayons.spinner_start(tag)
       sleep(1)
+      Crayons.spinner_log(command)
       Crayons.spinner_stop(nil, true)
     else
       Crayons.command(tag, command)
@@ -329,7 +332,7 @@ module Rvvm
     cmd_args = @config[:dpi][:args].strip
     dpilist = @args[:dpilist] || @config[:dpi][:list]
 
-    cmd = "sxc -f #{dpilist} #{cmd_args}"
+    cmd = "xsc -f #{dpilist} #{cmd_args}"
     execute("Building DPI-C library...", cmd)
   end
 
@@ -340,7 +343,10 @@ module Rvvm
   # @since 0.8.0
   def self.elaborate
     cmd_args = @config[:elaboration][:args]
-    cmd_args << " -sv_lib dpi" if @args[:dpi] || @args[:dpilib] || @config[:dpi][:dpilib] == 1
+    cmd_args << " -sv_lib #{@config[:elaboration][:customdpilib]}" if @config[:elaboration][:customdpilib] != ""
+    unless @config[:elaboration][:customdpilib] != ""
+      cmd_args << " -sv_lib dpi" if @args[:dpi] || @args[:dpilib] || @config[:dpi][:dpilib] == 1
+    end
     cmd_args << " -debug wave" if @args[:wave]
     cmd_args.strip!
     logname = @args[:elablog] || File.join([@config[:project][:logDir], @config[:elaboration][:logDir], @config[:elaboration][:log]])
@@ -494,7 +500,7 @@ module Rvvm
     if @args[:here]
       path = "."
     else
-      path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+      path = File.join([@config[:project][:path], @args[:path] || @templates[:package][:file][:path]])
     end
 
     Crayons.spinner_start("Generating SV pkg template...")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rvvm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - mrbya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow