(cherry picked from commit 4b891ecf

)

Co-authored-by: Adam Izraelevitz <adam.izraelevitz@sifive.com>

* Report firtool version when firtool invocation errors (#3174)

* the firtool version is now included in the BuildInfo
* firtool now must be on the path when publishing, but is not required
  for building or testing
* FirtoolNonZeroExitCode now no longer includes a stack trace

(cherry picked from commit 06b569da

)

# Conflicts:
#	build.sbt

* Resolve backport conflicts

* [CI] Install firtool in the publish step (#3176)

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>

* Fix naming for RHS of named unapply expressions (#3163)

Previously, the naming plugin would not recurse for the RHS of an
unapply, meaning that vals declared in blocks that ultimately return
some result that is unapplied into some named Data would not be named.

Also, audit and improve the naming mdocs.

(cherry picked from commit 262caa73

)

# Conflicts:
#	docs/src/cookbooks/naming.md

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit a6525268

)

Co-authored-by: Jack Koenig <koenig@sifive.com>

Co-authored-by: Jack Koenig <koenig@sifive.com>
(cherry picked from commit f3d0f22d

)

Co-authored-by: Aditya Naik <91489422+adkian-sifive@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Detect bound hardware when processing record elements (#3037)

Use new private Record._elements to validate Record elements. This
allows us to check invariants earlier than on cloning or binding.

(cherry picked from commit a8515661

)

# Conflicts:
#	core/src/main/scala/chisel3/internal/BiConnect.scala
#	core/src/main/scala/chisel3/internal/MonoConnect.scala

* Fix backport conflicts

---------

Co-authored-by: Aditya Naik <91489422+adkian-sifive@users.noreply.github.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit 29562386

)

Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit 068eb8f7

)

Co-authored-by: Jack Koenig <koenig@sifive.com>

* Add SBT aliases for formatting including SBT files (#3125)

Also run formatting on SBT files.

(cherry picked from commit 3da4113e

)

# Conflicts:
#	build.sbt
#	project/plugins.sbt

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit ac10d5b8

)

Co-authored-by: Sean Jensen-Grey <128454+seanjensengrey@users.noreply.github.com>

Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit baed66d4

)

Co-authored-by: jensengrey <46599294+jensengrey@users.noreply.github.com>

It seems that deprecations on methods that are macro expanded away do
not actually trigger a deprecation warning. Instead, we will just accept
no source locator on the deprecated API (no released version of Chisel
has the source locator).

(cherry picked from commit 847343a3

)

Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Deprecate ImplicitInvalidate

* Suppress warnings from ImplicitInvalidate

---------

Co-authored-by: Adam Izraelevitz <adam.izraelevitz@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Remove LegacyModule and LegacyBlackBox (#3058)

(cherry picked from commit 9b2e288c

)

# Conflicts:
#	core/src/main/scala/chisel3/internal/package.scala

* Change removal to deprecation

---------

Co-authored-by: Adam Izraelevitz <adam.izraelevitz@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Undo move of Cat from chisel3.util to chisel3 (#3110)

It is a very painful change for users with marginal benefit. We plan to
change the package to chisel in the not-so-distant future--that's a much
better opportunity to make this change.

(cherry picked from commit 036b1e90

)

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>

* overload MuxLookup.apply for EnumType
* remove MuxLookup.fromEnum
* add source locators to MuxLookup.apply using macros

(cherry picked from commit dcecabb6

)

Co-authored-by: Albert Chen <40366337+albertchen-sifive@users.noreply.github.com>

* Remove deprecated CIRCT Options (#3101)

* Make read-write inference on by default

Change CIRCT to turn on read-write inference by default.  This is
primarily done because this option was removed in:

  https://github.com/llvm/circt/commit/9620d656f8a59998cc38472a60f83bfdcb6a8549



Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

* Remove IMCP disable option for CIRCT

Remove the ability to disable inter-module constant propagation (IMCP) when
running with CIRCT.  This option was removed in:

  https://github.com/llvm/circt/commit/9620d656f8a59998cc38472a60f83bfdcb6a8549



Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

---------

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
(cherry picked from commit 3158c492

)

# Conflicts:
#	src/main/scala/circt/stage/phases/CIRCT.scala

* Resolve backport conflicts

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

* Fix FIRRTL spec emission and bump to spec 1.2.0 (#3094)

* Emit FIRRTL spec version in Emitter
* Bump FIRRTL spec version to 1.2.0

(cherry picked from commit 1ef1fc4e

)

# Conflicts:
#	firrtl/src/main/scala/firrtl/ir/Serializer.scala
#	firrtl/src/test/scala/firrtlTests/ExtModuleTests.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>

Also remove deploy_website job as we only want to deploy the website
from main.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit c246b28a

)

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 9a78f4f3

)

Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Create deprecated alias in package chisel3.util.

(cherry picked from commit ecc19a1d

)

Co-authored-by: Chick Markley <chick.markley@sifive.com>
Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Add test for new error message on litValue on Bundle containing DontCare
* Refactored so litValue errors when bundle has DontCare elements
  But that litOption does not error when bundle has DontCare elements

Co-authored-by: Jack Koenig <koenig@sifive.com>
(cherry picked from commit 07097ed6

)

Co-authored-by: Chick Markley <chick.markley@sifive.com>
Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* add MuxLookup.fromEnum

(cherry picked from commit 6dc2f58d)

* add example, better type signature

(cherry picked from commit c1b8e4c6

)

---------

Co-authored-by: Albert Chen <albert.chen@sifive.com>
Co-authored-by: Megan Wachs <megan@sifive.com>

Partial backport of https://github.com/chipsalliance/chisel/pull/3044, fetching the contributors needs to use the new chisel repo or it will fail.

* Get rid of warnings in / doc build
  Many `[[...]]` dont work so replace with back-ticks
  Printable docs are very problematic, use Warning suppression for those
* Enable fatal warnings in CI for ScalaDoc generation

Co-authored-by: Jack Koenig <koenig@sifive.com>

This includes new command-line option --source-root which allows the
user of Chisel to point to one or more root directories for source files.
If no --source-root arguments are provided, it will default to using
"." which should work for typical SBT and Mill projects.

Flag is `-DdisableFatalWarnings`
Add flag to a number of places in build.sbt

Also check ScalaDoc generation in CI

* In BoringUtils replace deprecated SyncVar with BuilderContextCache
* Handle potential in-exhaustive match error
* Changes lines to linesIterator to fix deprecation warning
* Change build.sbt to make fatal warnings error come after suppressed warnings

Fix a bug where "--split-verilog" was not properly passed into the
CIRCTOptions struct.  Add a test to lock in the correct behavior.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Deprecate ProtoBufFileFormat and warn if a user is doing Protobuf
emission.  This will be ripped out in Chisel 5.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>