Merge branch 'master' into 3.6-release

Author: jackkoenig

.github/workflows/install-circt/action.yml

@@ -4,7 +4,7 @@ inputs:
   version:
     description: 'version to install'
     required: false
-    default: 'sifive/1/24/0'
+    default: 'firtool-1.30.0'
 
 runs:
   using: composite

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
         jvm: ["8"]
         scala: ["2.13.10", "2.12.17"]
         espresso: ["2.4"]
-        circt: ["sifive/1/24/0"]
+        circt: ["firtool-1.30.0"]
     runs-on: ${{ matrix.system }}
 
     steps:
@@ -41,16 +41,13 @@ jobs:
         uses: ./.github/workflows/install-circt
         with:
           version: ${{ matrix.circt }}
-      - name: Use Treadle for Pull Requests
-        if: github.event_name == 'pull_request'
-        run: echo "CHISEL3_CI_USE_TREADLE=1" >> $GITHUB_ENV
       - name: Test
         run: sbt ++${{ matrix.scala }} test
       - name: Binary compatibility
         run: sbt ++${{ matrix.scala }} mimaReportBinaryIssues
 
   doc:
-    name: Formatting and Documentation
+    name: Formatting
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
@@ -65,8 +62,6 @@ jobs:
         uses: ./.github/workflows/install-circt
       - name: Check Formatting
         run: sbt scalafmtCheckAll
-      - name: Documentation
-        run: sbt docs/mdoc unidoc
 
   integration:
     name: Integration Tests (w/ chiseltest)
@@ -85,6 +80,11 @@ jobs:
           java-version: '11'
           cache: 'sbt'
       - name: Integration Tests
+        # This is here instead of on the whole job because, if a job is skipped, so are dependent jobs.
+        # If this job were skipped, all_tests_passed would be skipped too.
+        # By having this "if" here, this job returns success so that all_tests_passed will succeed too.
+        if: github.event_name != 'pull_request' ||
+          ! contains(github.event.pull_request.labels.*.name, 'Skip chiseltest')
         run: sbt integrationTests/test
 
   std:
@@ -110,13 +110,46 @@ jobs:
       - name: Unit Tests
         run: sbt ++${{ matrix.scala }} standardLibrary/test
 
+  website:
+    name: Build Mdoc & Website
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Scala
+        uses: olafurpg/setup-scala@v10
+        with:
+          java-version: adopt@1.8
+      - name: Cache Scala
+        uses: coursier/cache-action@v5
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+      - name: Setup Jekyll
+        run: |
+          gem install jekyll -v 4.2.0
+          gem install jekyll-redirect-from
+      - name: Install CIRCT
+        uses: ./.github/workflows/install-circt
+      - name: Build the microsite
+        run: make -C website
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Tar built website
+        run: tar zcf website.tar.gz website/docs/target/site
+      - name: Share Built Website
+        uses: actions/upload-artifact@v3
+        with:
+          name: website
+          path: website.tar.gz
+
   # Sentinel job to simplify how we specify which checks need to pass in branch
   # protection and in Mergify. This job checks that all jobs were successful.
   #
   # When adding new jobs, please add them to `needs` below
   check-tests:
     name: "check tests"
-    needs: [ci, integration, std, doc]
+    needs: [ci, integration, std, doc, website]
     runs-on: ubuntu-20.04
     if: success() # only run if all tests have passed
     outputs:
@@ -153,7 +186,7 @@ jobs:
   publish:
     needs: [all_tests_passed]
     runs-on: ubuntu-20.04
-    if: github.event_name == 'push'
+    if: (github.event_name == 'push' && github.ref_name != 'website-test')
 
     steps:
       - name: Checkout
@@ -173,3 +206,23 @@ jobs:
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+
+
+  deploy_website:
+    name: Deploy Website
+    runs-on: ubuntu-latest
+    needs: [all_tests_passed]
+    if: (github.event_name == 'push') && (github.ref_type == 'branch') && ((github.ref_name == 'website-test') || (github.ref_name == 'master'))
+    steps:
+      - name: Download built website
+        uses: actions/download-artifact@v3
+        with:
+          name: website
+      - name: Untar built website
+        run: tar zxf website.tar.gz
+      - name: Deploy Website to GitHub Pages (From Master Branch)
+        uses: JamesIves/github-pages-deploy-action@3.7.1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: website/docs/target/site

README.md

@@ -246,7 +246,8 @@ These simulation-based verification tools are available for Chisel:
 * [**Cheat Sheet**](https://github.com/freechipsproject/chisel-cheatsheet/releases/latest/download/chisel_cheatsheet.pdf), a 2-page reference of the base Chisel syntax and libraries
 * [**ScalaDoc**](https://www.chisel-lang.org/api/latest/chisel3/index.html), a listing, description, and examples of the functionality exposed by Chisel
 * [**Gitter**](https://gitter.im/freechipsproject/chisel3), where you can ask questions or discuss anything Chisel
-* [**Website**](https://www.chisel-lang.org) ([source](https://github.com/freechipsproject/www.chisel-lang.org/))
+* [**Website (3.6 and earlier)**](https://www.chisel-lang.org) ([source](https://github.com/freechipsproject/www.chisel-lang.org/))
+* [**Website (master)**](https://chipsalliance.github.io/chisel3) ([source](website)) (Note that this will replace the above after the 3.6 release)
 * [**Scastie (3.5.3)**](https://scastie.scala-lang.org/O3LqeVH7SWyIxD7bZRH8hA)
 * [**asic-world**](http://www.asic-world.com/verilog/veritut.html) If you aren't familiar with verilog, this is a good tutorial.
 
@@ -330,7 +331,6 @@ While we recommend using the library dependency approach as described above, it
 
 **Caveats**:
 
-* This only works for the "main" configuration; you cannot build the Chisel tests this way because `treadle` is only supported as a library dependency.
 * Do not `publishLocal` when building this way. The published artifact will be missing the FIRRTL dependency.
 
 This works by using [sbt-sriracha](http://eed3si9n.com/hot-source-dependencies-using-sbt-sriracha), an SBT plugin for toggling between source and library dependencies.
@@ -392,4 +392,4 @@ You are encouraged to do your development against the latest SNAPSHOT, but note
 
 ### Roadmap
 
-See [ROADMAP.md].
+See (Roadmap)[https://github.com/chipsalliance/chisel3/blob/master/README.md].

ROADMAP.md

@@ -43,7 +43,6 @@ spec and the Chisel APIs. Thus, the 3.6 release will:
   - Injecting Aspects
   - EnumAnnotations
   - RunFirrtlTransformAnnotation
-  - LoadMemoryFromFile
   - ChiselAnnotation/custom annotations
 - Publish Roadmap
 

SETUP.md

@@ -3,8 +3,7 @@ Instructions for setting up your environment to run Chisel locally.
 
 For a minimal setup, you only need to install [SBT (the Scala Build Tool)](http://www.scala-sbt.org), which will automatically fetch the appropriate version of Scala and Chisel based on on your project configuration.
 
-[Verilator](https://www.veripool.org/wiki/verilator) is optional, only if you need to run the Chisel3 regression suite, or simulate your Verilog designs.
-Note that both [PeekPokeTester](https://github.com/freechipsproject/chisel-testers) and [testers2](https://github.com/ucb-bar/chisel-testers2) both support using [treadle](https://github.com/freechipsproject/treadle) (a FIRRTL simulator written in Scala) as the simulation engine, which requires no additional installation steps.
+[Verilator](https://www.veripool.org/wiki/verilator) is installation is required to simulate your Verilog designs.
 
 ## Ubuntu Linux	
 

build.sbt

@@ -17,7 +17,7 @@ lazy val commonSettings = Seq(
   organization := "edu.berkeley.cs",
   version := "3.6.0-RC1",
   autoAPIMappings := true,
-  scalaVersion := "2.12.17",
+  scalaVersion := "2.13.10",
   crossScalaVersions := Seq("2.13.10", "2.12.17"),
   scalacOptions := Seq("-deprecation", "-feature"),
   libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value,
@@ -36,6 +36,16 @@ lazy val commonSettings = Seq(
   }
 )
 
+lazy val warningSuppression = Seq(
+  scalacOptions += "-Wconf:" + Seq(
+    "msg=APIs in chisel3.internal:s",
+    "msg=Importing from firrtl:s",
+    "msg=migration to the MLIR:s",
+    "msg=method hasDefiniteSize in trait IterableOnceOps is deprecated:s",  // replacement `knownSize` is not in 2.12
+    "msg=object JavaConverters in package collection is deprecated:s"
+  ).mkString(",")
+)
+
 lazy val publishSettings = Seq(
   versionScheme := Some("pvp"),
   publishMavenStyle := true,
@@ -70,7 +80,7 @@ lazy val publishSettings = Seq(
 lazy val chiselSettings = Seq(
   name := "chisel3",
   libraryDependencies ++= Seq(
-    "org.scalatest" %% "scalatest" % "3.2.14" % "test",
+    "org.scalatest" %% "scalatest" % "3.2.15" % "test",
     "org.scalatestplus" %% "scalacheck-1-14" % "3.2.2.0" % "test",
     "com.lihaoyi" %% "upickle" % "2.0.0"
   )
@@ -171,14 +181,14 @@ lazy val core = (project in file("core"))
   )
   .settings(publishSettings: _*)
   .settings(mimaPreviousArtifacts := Set())
+  .settings(warningSuppression: _*)
   .settings(
     name := "chisel3-core",
     libraryDependencies ++= Seq(
       "com.lihaoyi" %% "upickle" % "2.0.0",
       "com.lihaoyi" %% "os-lib" % "0.8.1"
     ),
     scalacOptions := scalacOptions.value ++ Seq(
-      "-deprecation",
       "-explaintypes",
       "-feature",
       "-language:reflectiveCalls",
@@ -202,9 +212,9 @@ lazy val chisel = (project in file("."))
   .dependsOn(macros)
   .dependsOn(core)
   .aggregate(macros, core, plugin)
+  .settings(warningSuppression: _*)
   .settings(
     mimaPreviousArtifacts := Set(),
-    libraryDependencies += defaultVersions("treadle") % "test",
     Test / scalacOptions ++= Seq("-language:reflectiveCalls"),
     // Forward doc command to unidoc
     Compile / doc := (ScalaUnidoc / doc).value,
@@ -242,11 +252,11 @@ lazy val chisel = (project in file("."))
       // See https://github.com/sbt/sbt-unidoc/issues/107
       (core / Compile / sources).value.map("-P:chiselplugin:INTERNALskipFile:" + _)
       ++ {
-           CrossVersion.partialVersion(scalaVersion.value) match {
-             case Some((2, n)) if n >= 13 => "-implicits" :: Nil
-             case _                       => Nil
-           }
-         }
+        CrossVersion.partialVersion(scalaVersion.value) match {
+          case Some((2, n)) if n >= 13 => "-implicits" :: Nil
+          case _                       => Nil
+        }
+      }
   )
 
 // tests elaborating and executing/formally verifying a Chisel circuit with chiseltest

build.sc

@@ -24,9 +24,8 @@ def getVersion(dep: String, org: String = "edu.berkeley.cs") = {
 
 object v {
   val firrtl = getVersion("firrtl")
-  val treadle = getVersion("treadle")
   val chiseltest = ivy"edu.berkeley.cs::chiseltest:0.6-SNAPSHOT"
-  val scalatest = ivy"org.scalatest::scalatest:3.2.14"
+  val scalatest = ivy"org.scalatest::scalatest:3.2.15"
   val scalacheck = ivy"org.scalatestplus::scalacheck-1-14:3.2.2.0"
   val osLib = ivy"com.lihaoyi::os-lib:0.8.1"
   val upickle = ivy"com.lihaoyi::upickle:2.0.0"
@@ -43,14 +42,6 @@ trait CommonModule extends CrossSbtModule with PublishModule with ScalafmtModule
     )
   else Agg.empty[Dep]
 
-  def treadleModule: Option[PublishModule] = None
-
-  def treadleIvyDeps = if (treadleModule.isEmpty)
-    Agg(
-      v.chiseltest
-    )
-  else Agg.empty[Dep]
-
   def chiseltestModule: Option[PublishModule] = None
 
   def chiseltestIvyDeps = if (chiseltestModule.isEmpty)
@@ -140,19 +131,19 @@ class chisel3CrossModule(val crossScalaVersion: String) extends CommonModule wit
     override def ivyDeps = m.ivyDeps() ++ Agg(
       v.scalatest,
       v.scalacheck
-    ) ++ m.treadleIvyDeps
+    )
 
-    override def moduleDeps = super.moduleDeps ++ treadleModule
+    override def moduleDeps = super.moduleDeps
   }
 
   object `integration-tests` extends Tests with TestModule.ScalaTest with ScalafmtModule {
     override def sources = T.sources(millSourcePath / "integration-tests" / "src" / "test" / "scala")
     override def ivyDeps = m.ivyDeps() ++ Agg(
       v.scalatest,
       v.scalacheck
-    ) ++ m.treadleIvyDeps ++ m.chiseltestIvyDeps
+    ) ++ m.chiseltestIvyDeps
 
-    override def moduleDeps = super.moduleDeps ++ Seq(stdlib) ++ treadleModule ++ chiseltestModule
+    override def moduleDeps = super.moduleDeps ++ Seq(stdlib) ++ chiseltestModule
   }
 
   override def buildInfoPackageName = Some("chisel3")