They are commonly used and if we were ever to change them, we will need
to go through a deprecation process anyway.

Note that the EnumAnnotations remain in chisel3.experimental because,
like all Chisel annotation support, they are slated to be deprecated and
removed.

* Support generate structured decoder with DecodeTable

* Add documentation for DecodeTable

This would previously end up throwing an exception later, when trying
to create a component name and realizing that it was invalid. Instead,
this detects Vec subaccesses early, and gives a more precise error and
suggestion.

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

Instantiate is an experimental new API that provides a similar style of
Module instantiation to Module(new MyModule), but using Definition and
Instance under-the-hood to only elaborate Modules with the same
parameters a single time.

ChiselEnums check if they should create annotations every time an
instance of them is bound. Because so many annotations would be created,
they check to see if an equivalent annotation has already been added to
the annotations. Previously, this used a linear search of the
annotations, now it uses a HashSet.

Fix lazy cloning and apply the optimization in more cases

Previously it used a calculation of whether a given Record (or Bundle)
contained an "external reference", defined as any element with an _id
less than the _id of the Record. This does not work for certain cases
because it is not recursive and a child Record could itself contain an
external reference. Changing the calculation to be recursive negates
much of the benefit because many cases that should not need to clone end
up cloning.

The new algorithm instead uses a notion of "minimum id" for a Data. For
most Data, this is just _id, but for Records, it is the minimum id of
any of its children (recursively). This does replace the previous 1-byte
memoized field with an 8-byte field, but this algorithm works better and
should result in more savings from lazy cloning.

In cases when Flipped needs to clone, it was using the specified
direction of the clone. Since cloneType does not propagate
specifiedDirection, it was essentially always flipping an unspecified
direction even if the direction had been specified.

* Minor tweaks to setup-oss-cad-suite
* Switch espresso installation to composite action
* Switch circt installation to composite action

* Added option to disable deprecation of SFC import using wConf

The YosysHQ Github Action for setting up the OSS CAD Suite is very flaky
in CI so instead we can just wget and untar the suite ourselves. It also
seems prudent to try out composite actions to avoid duplication of
installation steps.

Deprecate Fixed Point and Intervals

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

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

Add a deprecation string that can be used for marking things that are
deprecated due to the MLIR-based FIRRTL Compiler (MFC) migration.  Do
not use this anywhere (yet).

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

[circt] Cleanup CIRCT error behavior

Change all docs to use CIRCT in their mdoc regions.  Everything worked
without issue except for one weird mdoc region in hierarchy.md which I
am not sure how it is even legal.  This mdoc region has been disabled
for now.

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

Improve the error message that trips if firtool is not found.  Add a new
exception and throw this when execution of the firtool process fails.
This commit tries to narrowly only match on the exact condition that
this failed due to firtool not being installed.

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

Change the behavior of what happens if firtool returns a non-zero exit
code from printing information to stdout to throwing an exception with
this information in the body.  This is done primarily to ease
interoperability with mdoc.  However, this is generally better
principled than the previous behavior of scattering information in
different mediums.  Add a test of this behavior.

Stop intercepting a file not found error if CIRCT fails to print this to
stdout and wrap this in a StageError.  It is better to just let the file
not found exception through as this already includes all the information
necessary to tell the user what the problem is.  Do not test this
behavior (as it is tedious to test).

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

* Bugfix waiveEach not casting. Add waiveAllAs

* Add implicit type constraints to connectable apis

* Swapped order T =:= S for clearer error messages

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

* Fix BitSet decoder API when errorBit=False

    When errorBit is set to False, the original code will return
    `Unit` which will be `()` in interpolated string.

* Add testcases for both errorBit cases in BitSetSpec

* chisel-circt: pullin src/main/scala changes from 0.8.0
* chisel-circt: pullin src/test/scala changes from 0.8.0
* chisel-circt: bump circt verstion to match what is on 0.8.0

* Switch from deprecated setup-scala to setup-java
* Switch from deprecated set-output to $GITHUB_OUTPUT
* Use $GITHUB_STEP_SUMMARY for reporting

* Remove parenthesized forms of:
`.unary_-()`, `.unary_%()`, `.unary_~()`, `.unary_!()`,
`.orR()`, `.andR()`, `.xorR()`,  `.zext()`, 
`.asBool()`, `.asBools()`, `.asSInt()`, `.asAsyncReset()`,
`.asClock()`, `.isLit()`, `.litOption()`, `.litValue()`,
`.abs()`
* Remove protected `Data.bindingToString`
* Remove `RawModule.getPorts`
* Remove `._applyMacroWithMessage` in assert and assume
* Remove `stop` that accepts non-zero return code
* Remove public `WhenContext` constructor
* Remove parenthesized `WhenContext.active()`
* Remove `blacklistPackages`, `builderName`, and `chiselStackTrace` from `ChiselException`
* Remove `MultiIOModule` (`Module` can have multiple `IOs`)
* Remove `chisel3.getModulePorts`
* Undo deprecation of `Data.flatten` which is package private and useful
* Also remove all internal uses of these removed methods

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

This allows build tools to warn users about possible binary
incompatibility issues when using dependencies that depend on
mutually incompatible versions of Chisel.

This means dropping Scala 2.12.4 support which is broken in Zinc newer
than 1.6.0. Chisel users of Scala 2.12.4 should upgrade to 2.12.17.

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