* Improve CI sentinel job for better branch protection (#2743)

Previously, failed jobs in the CI matrix would cause the sentinel job
(all-tests-passed) to be skipped, which for purposes of Github Actions
branch protection would count as "success". This allowed PRs with
failing CI to be merged. This new approach which uses two sentinel jobs
should not suffer from this same issue.

(cherry picked from commit cc507a84

)

# Conflicts:
#	.github/workflows/test.yml

* Resolve backport conflicts

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

This enables emission of modules that serialize to >2 GiB of .fir text.

(cherry picked from commit 2cbc852d

)

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

* Cleanup Cookbook and printing docs
* Format specifiers are actually concise now

Co-authored-by: Megan Wachs <megan@sifive.com>
(cherry picked from commit df2a7183

)

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

* Bump to Scala 2.13.9 and 2.12.17 (#2739)

(cherry picked from commit 647c8a45

)

# Conflicts:
#	.github/workflows/test.yml

* Resolve backport conflicts

* Update mimaPreviousArtifacts

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

Referenced to: chipsalliance/chisel3#2728

(cherry picked from commit a4dae9c3

)

Co-authored-by: Marco Origlia <30799310+moriglia@users.noreply.github.com>

(cherry picked from commit 248daa5f

)

Co-authored-by: Jiuyang Liu <liu@jiuyang.me>

* Remove incorrect clock warning on Mem.read (#2721)

Mem.read is combinational and thus unaffected by the clock, and so it
does not make sense to issue warnings about the current clock in this
context.

(cherry picked from commit 5fdf74f9

)

* Keep old version of MemBase.clockWarning for binary compatibility

This method is impossible for users to call, but it is easy enough to
keep around a version of it to make MiMa happy.

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

This reverts commit de76e70b.

(cherry picked from commit e1e0503d

)

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

- Remove line defeating having wire locators
  `implicit val noSourceInfo = UnlocatableSourceInfo` from `WireDefault#apply`
- Add test to show locators

(cherry picked from commit f701a9f8

)

Co-authored-by: Chick Markley <chick.markley@sifive.com>

We need to ensure that contextual names stay contextual (ie. sensitive
to the module context which is important for naming ports).

(cherry picked from commit cee25521

)

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

* Bugfix - OpaqueSlot replace invalid localName (#2701)

(cherry picked from commit fb8ea2a2

)

* Fix cloneTypes (#2703)

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

(cherry picked from commit 78265e18

)

Co-authored-by: Jiuyang Liu <liu@jiuyang.me>

(cherry picked from commit 1a23b424

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

(cherry picked from commit 67cff825

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

* Add OpaqueType support to Records (#2662)

OpaqueTypes are essentially type aliases that hide the underlying type.
They are implemented in Chisel as Records of a single, unnamed element
where the wrapping Record does not exist in the emitted FIRRTL.

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

)

* Fix test compilation

* Fix OpaqueType tests in RecordSpec

Need to implement cloneType correctly and to warn instead of error when
accessing .toTarget of non-hardware types because that is a warning (not
error) in 3.5.

* Waive MiMa false positives

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

* Add a cookbook and publicly visible scaladoc for prefix, noPrefix

(cherry picked from commit ae7dc30b

)

Co-authored-by: Megan Wachs <megan@sifive.com>

(cherry picked from commit de76e70b

)

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

* Printables for verification preconditions (#2663)

Add support for printable within assert and assume verification statements

Co-authored-by: Girish Pai <girish.pai@sifive.com>
Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
(cherry picked from commit 7df56533

)

* Waive MiMa false positive

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

* Add option to treat warnings as errors (#2676)

Add --warnings-as-errors option

(cherry picked from commit 49894666

)

# Conflicts:
#	core/src/main/scala/chisel3/experimental/hierarchy/Definition.scala
#	core/src/main/scala/chisel3/internal/Builder.scala
#	src/main/scala/chisel3/aop/injecting/InjectingAspect.scala
#	src/main/scala/chisel3/stage/ChiselOptions.scala
#	src/main/scala/chisel3/stage/package.scala
#	src/main/scala/chisel3/stage/phases/Elaborate.scala

* Resolve backport conflicts

Co-authored-by: Zachary Yedidia <zyedidia@gmail.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit ae76ff4c

)

Co-authored-by: Zachary Yedidia <zyedidia@gmail.com>

(cherry picked from commit 1ad820f7

)

Co-authored-by: Zachary Yedidia <zyedidia@gmail.com>

* Replace some options with nullable vars (#2658)

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

)

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

* Fix backport conflicts (#2661)

Co-authored-by: Zachary Yedidia <zyedidia@gmail.com>

(cherry picked from commit 0b2c211b

)

Co-authored-by: Megan Wachs <megan@sifive.com>

(cherry picked from commit 8538269a

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

We no longer meet on Tuesdays, only Mondays.

(cherry picked from commit 28c79fd4

)

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

Release automation tries to bump chiseltest which causes issues due to
SBT trying to resolve all dependencies (even for projects that will not
be published, like integrationTests).

(cherry picked from commit b20df1d6

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

(cherry picked from commit 81fcf229

)

Co-authored-by: Megan Wachs <megan@sifive.com>

This is required in order to support peeks in
chiseltest.

(cherry picked from commit 26cd15a9

)

Co-authored-by: Kevin Laeufer <laeufer@cs.berkeley.edu>

Also remove all non-testing uses of chiselName.

(cherry picked from commit 1c5d1b53

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

* Add copy constructors for compile options
* Add tests for the copy constructors

Co-authored-by: Jiuyang Liu <liu@jiuyang.me>

(cherry picked from commit 4b10cf7a

)

Co-authored-by: Girish Pai <girish.pai@sifive.com>

* Update scala-compiler, scala-library, ... to 2.12.16 (#2618)

* Update scala-compiler, scala-library, ... to 2.12.16
* Add 2.12.16 to compiler plugin crossbuild

Co-authored-by: Jack Koenig <jack.koenig3@gmail.com>
(cherry picked from commit e4f66357

)

# Conflicts:
#	.github/workflows/test.yml

* Resolve backport conflicts

* Ignore lack of plugin 3.5.3 artifact for Scala 2.12.16

Since 2.12.16 did not exist when 3.5.3 was published, there is no
artifact for the plugin so we must ignore it until 3.5.4 is released.

Co-authored-by: Scala Steward <43047562+scala-steward@users.noreply.github.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

(cherry picked from commit 11e8cc60

)

Co-authored-by: Megan Wachs <megan@sifive.com>

* Refactor TruthTable.apply and add factory method for Espresso (#2612)

Improves performance of creating TruthTables by processing entire BitPats
rather than individual bits. New TruthTable factory method enables
constructing TruthTables with semantics of OR-ing output BitPats together
rather than erroring when multiple terms have the same input BitPat.
This alternative factory method matches semantics for the output format
of Espresso.

Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
(cherry picked from commit 231f14e7

)

# Conflicts:
#	src/main/scala/chisel3/util/BitPat.scala

* Resolve backport conflicts

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

Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: Megan Wachs <megan@sifive.com>
(cherry picked from commit 3ab34cdd

)

Co-authored-by: Jared Barocsi <82000041+jared-barocsi@users.noreply.github.com>

Links between markdown pages should not have any file extension to ensure they work on the website.

(cherry picked from commit 04d4dc6d

)

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