* Add initial roadmap
Co-authored-by: edwardcwang <edwardcwang@users.noreply.github.com>

(cherry picked from commit 7f73d18e

)

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

* Add Scalafmt for mill (#2805)

* add scalafmt for test in mill build system.
* reformat codes in integration-tests

(cherry picked from commit d881fd29

)

# Conflicts:
#	build.sc
#	integration-tests/src/test/scala/chiselTests/util/experimental/BitPat.scala

* Resolve backport conflicts

Co-authored-by: Jiuyang Liu <liu@jiuyang.me>
Co-authored-by: Jack Koenig <koenig@sifive.com>

MonoConnect.traceFlow now properly handles coerced directions.
Also minor improvement to getClassName especially useful in test case printf debugging.

(cherry picked from commit 3aba755b

)

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

* Don't invalidate ExtModule ports in an explicitInvalidate = true context (#2795)

* Don't invalidate ExtModule ports in an explicitInvalidate = true context

ExtModule ports were previously invalidated in the emitted FIRRTL, which is correct in a NonStrict / `Chisel._` compatibility context but not in newer chisel3 code where `explicitInvalidate = true`.

(cherry picked from commit 8e24a281

)

# Conflicts:
#	core/src/main/scala/chisel3/BlackBox.scala

* Resolve backport conflicts

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

* Only set the chisel3 Builder prefix during the first invocation of suggestName

(cherry picked from commit b684506a)

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

* Add simple test to show bug fix

(cherry picked from commit 255068b1

)

* Fix merge conflict

* Fix test to not use Hardware inside a bundle for prefixing

Co-authored-by: Jared Barocsi <jared.barocsi@sifive.com>

Add utilities to enable backwards compatibility of the Trace.traceName
API to Chisel 3.5.x.  This adds a Trace.traceNameV2 utility which
aliases to Trace.traceName.  This also removes the TraceNameAnnotation
and renames it TraceAnnotation.  In 3.5.x, traceName will point at
TraceNameAnnotation (which has don't touch behavior) and will be
deprecated telling people to use traceNameV2 which will point at
TraceAnnotation (which does not have don't touch behavior).  This will
require fixups to the backport associated with this PR.

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

)

# Conflicts:
#	core/src/main/scala/chisel3/experimental/Trace.scala

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

* Add opt-in AutoCloneType for Records (#2781)

There is a new trait, chisel3.experimental.AutoCloneType that is mixed
in to Bundle and can optionally be mixed in to user-defined Records. The
compiler plugin prints a deprecation warning on any user-defined
implementation of cloneType, telling the user to mix in AutoCloneType
before upgrading to 3.6.

(cherry picked from commit a234fd48

)

# Conflicts:
#	core/src/main/scala/chisel3/Aggregate.scala
#	plugin/src/main/scala/chisel3/internal/plugin/BundleComponent.scala

* Resolve backport conflicts

* Do not make MixedVec extend AutoCloneType

It is a binary incompatible change that can wait for 3.6.

* Waive MiMa false positives

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

* Bump to Scala 2.13.10 (#2774)

2.13.9 has a binary compatibility regression so should be avoided.

(cherry picked from commit c53265d6

)

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

* Fix backport conflicts

* Fix scalaVersion in README

* Waive binary compatibility check for plugin for 2.13.10

3.5.4 is published for 2.13.10 so we cannot check binary compatibility
for it.

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

(cherry picked from commit 693678db

)

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

* Fix traceName module type to RawModule (#2765)

Change the type of modules that the traceName API can be used for from
"Module" to "RawModule".  This fixes a bug where this API couldn't be
used for RawModules even though it totally works.

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

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

)

* Fix binary compatibility issue

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

* Add unit test for Issue 2760

* checkpoint: Fix for nested instance

* remove comments about stuff not working

* make the test check the output a little more

* relax the requirement on returning empty ioMap

* Update core/src/main/scala/chisel3/experimental/hierarchy/core/Lookupable.scala

* Update core/src/main/scala/chisel3/Data.scala

* Update core/src/main/scala/chisel3/experimental/hierarchy/core/Lookupable.scala

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

* Update src/test/scala/chiselTests/experimental/hierarchy/InstanceSpec.scala

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

* Update core/src/main/scala/chisel3/experimental/hierarchy/core/Lookupable.scala

* Add another unit test which unfortunately still passes

* Update core/src/main/scala/chisel3/Data.scala

* Update src/test/scala/chiselTests/experimental/hierarchy/InstanceSpec.scala

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

)

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

(cherry picked from commit 0ff99ca8

)

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

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

)

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

(cherry picked from commit f462c9f9

)

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

* [ci] Split formatting and docs checks into separate task (#2749)

(cherry picked from commit ed269429

)

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

* Resolve backport conflicts

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

* Support using Treadle for 'sbt test'

Treadle will be used as the "defaultBackend" when the environment
variable CHISEL3_CI_USE_TREADLE is set. The intent is to set this
variable during CI for pre-merge CI (aka on pull requests).

(cherry picked from commit 7d39b7bd)

* Use Treadle for CI on pull requests

(cherry picked from commit 82660673

)

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

* 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>