Update libraries, improve buildfiles

Author: carlosedp

Makefile

@@ -1,5 +1,4 @@
 # Source and target files/directories
-project = $(shell grep object build.sc |grep -v extends |sed s/object//g |xargs)
 scala_files = $(wildcard src/main/scala/*.scala)
 generated_files = generated
 BUILDTOOL ?= sbt 							# Can also be mill
@@ -16,9 +15,10 @@ else
 endif
 
 # Define utility applications
-# VERILATOR= docker $(DOCKERARGS) hdlc/verilator verilator	# Docker Verilator
-VERILATOR=verilator  # Local Verilator
 YOSYS = docker $(DOCKERARGS) hdlc/yosys yosys
+VERILATORARGS = --name verilator --hostname verilator --rm -it --entrypoint= -v $(PWD):/work -w /work
+VERILATOR=  # Local Verilator
+# VERILATOR = docker $(DOCKERARGS) $(VERILATORARGS) verilator/verilator
 
 # Default board PLL
 BOARD := bypass
@@ -35,13 +35,15 @@ $(generated_files): $(scala_files) build.sbt
 	@if [ $(BUILDTOOL) = "sbt" ]; then \
 		${SBT} "run $(CHISELPARAMS) $(BOARDPARAMS)"; \
     elif [ $(BUILDTOOL) = "mill" ]; then \
+		project=grep object build.sc |grep -v extends |sed s/object//g |xargs \
 		scripts/mill $(project).run $(CHISELPARAMS) $(BOARDPARAMS); \
 	fi
 
 chisel_tests:
 	@if [ $(BUILDTOOL) = "sbt" ]; then \
 		${SBT} "test"; \
     elif [ $(BUILDTOOL) = "mill" ]; then \
+		project=grep object build.sc |grep -v extends |sed s/object//g |xargs \
 		scripts/mill $(project).test; \
 	fi
 
@@ -52,21 +54,19 @@ check: chisel_tests ## Run Chisel tests
 test: chisel_tests
 
 # This section defines the Verilator simulation and demo application to be used
-# Adjust the rom and ram files below to match your test
-romfile = gcc/helloUART/main-rom.mem
-ramfile = gcc/helloUART/main-ram.mem
 verilator: $(generated_files) ## Generate Verilator simulation
 	@rm -rf obj_dir
-	$(VERILATOR) -O3 --assert $(foreach f,$(wildcard generated/*.v),--cc $(f)) --exe verilator/chiselv.cpp verilator/uart.c --top-module Toplevel -o chiselv --timescale 1ns/1ps
-	@make -C obj_dir -f VToplevel.mk -j`nproc`
+	$(VERILATOR) verilator -O3 --assert $(foreach f,$(wildcard generated/*.v),--cc $(f)) --exe verilator/chiselv.cpp verilator/uart.c --top-module Toplevel -o chiselv --timescale 1ns/1ps
+	make -C obj_dir -f VToplevel.mk -j`nproc`
 	@cp obj_dir/chiselv .
-	@cp $(romfile) progload.mem
-	@cp $(ramfile) progload-RAM.mem
 
+# Adjust the rom and ram files below to match your test
+romfile = gcc/helloUART/main-rom.mem
+ramfile = gcc/helloUART/main-ram.mem
 verirun: ## Run Verilator simulation with ROM and RAM files to be loaded
 	@cp $(romfile) progload.mem
 	@cp $(ramfile) progload-RAM.mem
-	./chiselv
+	@bash -c "trap 'reset' EXIT; ./chiselv"
 
 MODULE ?= Toplevel
 dot: $(generated_files) ## Generate dot files for Core

README.md

@@ -34,26 +34,26 @@ Currently the target builds a RV32I core.
 
 ## Generating Verilog
 
-Verilog code can be generated from Chisel by using the `chisel` Makefile target. It requires a `-board` parameter so the correct PLL is included in the design. If it's not provided, a bypass PLL will be used.
+Verilog code can be generated from Chisel sources by using the `chisel` Makefile target. If a `-board` parameter is passed, the target board PLL is included in the design. If it's not provided, a bypass PLL will be used.
 
 ```sh
 make chisel BOARD=artya7-35
 ```
 
-The `BOARD` argument must match one of the `pll_BOARD.v]` files in `/src/main/resources` directory.
+The `BOARD` argument must match one of the `pll_BOARD.v` files in `/src/main/resources` directory.
 
 The core can be simulated in Verilator using the commands:
 
 ```sh
 make verilator   # this will build the SOC, generate the Verilog files and Verilator project
-make verirun     # This will copy the UART demo (RAM/ROM) from gcc/helloUART and run Verilator
+make verirun     # This will copy the UART demo (RAM/ROM) binaries from gcc/helloUART and run Verilator
 ```
 
 The demo application can be adjusted in the Makefile to point to the dir and files for ROM and RAM.
 
 ## Building for FPGAs
 
-The standard build process uses locally installed tools like Java (for Chisel generation), Yosys, NextPNR, Vivado and others. It's recommended to use [Fusesoc](https://github.com/olofk/fusesoc) for building the complete workflow by using containers thru a command launcher.
+The standard build process uses locally installed tools like Java (for Chisel generation), Yosys, NextPNR, Vivado and others. It's recommended to use [Fusesoc](https://github.com/olofk/fusesoc) for building the complete workflow by using containers thru a command launcher. In this case, the FPGA tools doesn't need to be installed locally.
 
 ### Fusesoc build and generation
 

build.sbt

@@ -3,16 +3,17 @@
 ThisBuild / organization := "com.carlosedp"
 ThisBuild / description  := "ChiselV is a RISC-V core written in Chisel"
 ThisBuild / homepage     := Some(url("https://carlosedp.com"))
-ThisBuild / licenses     := Seq("MIT" -> url("https://opensource.org/licenses/MIT"))
+ThisBuild / licenses     := Seq("BSD 3-Clause" -> url("https://github.com/carlosedp/chiselv/blob/main/LICENSE"))
 ThisBuild / scmInfo := Some(
   ScmInfo(url("https://github.com/carlosedp/chiselv"), "[email protected]:carlosedp/chiselv.git")
 )
 ThisBuild / developers := List(
   Developer("carlosedp", "Carlos Eduardo de Paula", "[email protected]", url("https://github.com/carlosedp"))
 )
+
 ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % "0.5.0"
 Global / semanticdbEnabled                                 := true
-Global / semanticdbVersion                                 := "4.4.28" //scalafixSemanticdb.revision // Force version due to compatibility issues
+Global / semanticdbVersion                                 := scalafixSemanticdb.revision
 Global / onChangedBuildSource                              := ReloadOnSourceChanges
 
 Compile / run / mainClass := Some("chiselv.Toplevel")
@@ -22,29 +23,31 @@ lazy val chiselv = (project in file("."))
   .settings(
     name         := "chiselv",
     version      := "1.0.0",
-    scalaVersion := "2.13.6"
+    scalaVersion := "2.13.7"
   )
 
 // Default library versions
-val defaultVersions = Map(
-  "chisel3"          -> "3.5.0-RC1",
-  "chiseltest"       -> "0.5-SNAPSHOT",
-  "scalatest"        -> "3.2.10",
-  "organize-imports" -> "0.5.0",
-  "scalautils"       -> "0.7.2"
-)
+lazy val versions = new {
+  val chisel3 = "3.5.0-RC2"
+  // val firrtl          = "1.5-SNAPSHOT"
+  val chiseltest      = "0.5.0-RC2"
+  val scalatest       = "3.2.10"
+  val organizeimports = "0.5.0"
+  val scalautils      = "0.7.2"
+  val oslib           = "0.8.0"
+}
 
 // Import libraries
 libraryDependencies ++= Seq(
-  "edu.berkeley.cs" %% "chisel3"    % defaultVersions("chisel3"),
-  "edu.berkeley.cs" %% "chiseltest" % defaultVersions("chiseltest") % "test",
-  "org.scalatest"   %% "scalatest"  % defaultVersions("scalatest")  % "test",
-  "com.carlosedp"   %% "scalautils" % defaultVersions("scalautils"),
-  "com.lihaoyi"     %% "os-lib"     % "0.7.8",
-  "edu.berkeley.cs" %% "firrtl"     % "1.5-SNAPSHOT" // Force using SNAPSHOT until next RC is cut (memory synth)
+  "edu.berkeley.cs" %% "chisel3"    % versions.chisel3,
+  "edu.berkeley.cs" %% "chiseltest" % versions.chiseltest % "test",
+  "org.scalatest"   %% "scalatest"  % versions.scalatest  % "test",
+  "com.carlosedp"   %% "scalautils" % versions.scalautils,
+  "com.lihaoyi"     %% "os-lib"     % versions.oslib
+  // "edu.berkeley.cs" %% "firrtl"     % versions.firrtl // Force using SNAPSHOT until next RC is cut (memory synth)
 )
-ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % defaultVersions("organize-imports")
-addCompilerPlugin(("edu.berkeley.cs"                        % "chisel3-plugin"   % defaultVersions("chisel3")).cross(CrossVersion.full))
+ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports" % versions.organizeimports
+addCompilerPlugin(("edu.berkeley.cs"                        % "chisel3-plugin"   % versions.chisel3).cross(CrossVersion.full))
 
 // Aliases
 addCommandAlias("com", "all compile test:compile")

project/build.properties

@@ -1 +1 @@
-sbt.version=1.5.5
+sbt.version=1.6.1

project/plugins.sbt

@@ -1,3 +1,3 @@
-addSbtPlugin("org.scalameta"    % "sbt-scalafmt" % "2.4.4")
-addSbtPlugin("ch.epfl.scala"    % "sbt-scalafix" % "0.9.32")
-addSbtPlugin("com.timushev.sbt" % "sbt-updates"  % "0.6.0")
+addSbtPlugin("org.scalameta"    % "sbt-scalafmt" % "2.4.6")
+addSbtPlugin("ch.epfl.scala"    % "sbt-scalafix" % "0.9.33")
+addSbtPlugin("com.timushev.sbt" % "sbt-updates"  % "0.6.1")