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

)

Co-authored-by: Michael Etzkorn 叶明凯 <34870910+metzkorn@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

(cherry picked from commit 6ecf4d39

)

Co-authored-by: Carlos Eduardo <me@carlosedp.com>

Used for separate elaboration of Definition and Instance

(cherry picked from commit 48d57cc8

)

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

* Make readme friendlier to beginners (#2586)

(cherry picked from commit 773d2d67

)

# Conflicts:
#	README.md

* Resolve backport conflicts

Co-authored-by: Carlos Eduardo <me@carlosedp.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

Previously, the plugin would crash with a useless internal error.

(cherry picked from commit 9fcfb252

)

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

(cherry picked from commit d54a37a5

)

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

* Define leading '_' as API for creating temporaries

Chisel and FIRRTL have long used signals with names beginning with an
underscore as an API to specify that the name does not really matter.
Tools like Verilator follow a similar convention and exclude signals
with underscore names from waveform dumps by default. With the
introduction of compiler-plugin prefixing in Chisel 3.4, the convention
remained but was hard for users to use unless the unnnamed signal
existed outside of any prefix domain. Notably, unnamed signals are most
useful when creating wires inside of utility methods which almost always
results in the signal ending up with a prefix.

With this commit, Chisel explicitly recognizes signals whos val names
start with an underscore and preserve that underscore regardless of any
prefixing. Chisel will also ignore such underscores when generating
prefixes based on the temporary signal, preventing accidental double
underscores in the names of signals that are prefixed by the temporary.

(cherry picked from commit bd943662)

* Remove unused defaultPrefix argument from _computeName

(cherry picked from commit ec178aa2

)

# Conflicts:
#	core/src/main/scala/chisel3/Module.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/ModuleClone.scala

* Resolve backport conflicts

* Waive false positive binary compatibility errors

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

* Added ImplicitInvalidate trait with tests

(cherry picked from commit 1356ced1

)

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

BitPat.rawString is called a lot when decoding and is used for certain
BitPat operations. We should use it less but this is at least a bandaid.

(cherry picked from commit c11af20f

)

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

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

)

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

Include the function being called in the suggestion.

(cherry picked from commit 296623f6

)

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

(cherry picked from commit 255c56c3

)

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

* Factor buildName into reusable function

The new function is chisel3.internal.buildName.

(cherry picked from commit 370ca8ac)

* Add --warn:reflective-naming

This new argument (and associated annotation) will turn on a warning
whenever reflective naming changes the name of a signal. This is
provided to help migrate from Chisel 3.5 to 3.6 since reflective naming
is removed in Chisel 3.6.

(cherry picked from commit 97afd9b9

)

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

* Deprecate .U() and .S() syntax for literal bit extracts (#2534)

(cherry picked from commit cadaf33a

)

# Conflicts:
#	macros/src/main/scala/chisel3/internal/sourceinfo/SourceInfoTransform.scala

* Fix backport conflict (#2560)

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

Previously, verification statements (assert, assume, cover, and printf)
were only named via reflection.

(cherry picked from commit 7fa2691f

)

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

This is a formatted version of the p"..." interpolator analogous to
Scala's f"..." interpolator. The primary difference is that it supports
formatting interpolated variables by following the variable with
"%<specifier>". For example:

printf(cf"myWire = $myWire%x\n")

This will format the hardware value "myWire" as a hexidecimal value in
the emitted Verilog. Note that literal "%" must be escaped as "%%".

Scala types and format specifiers are supported and are handled in the
same manner as in standard Scala f"..." interpolators.

(cherry picked from commit 037f7b2f

)

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

This includes (and is tested) for both the old .*Name APIs and
.toTarget

(cherry picked from commit 6e0d8d6b

)

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

ExtModule now uses the same namePorts implementation as regular Modules.
Previously, ExtModules only allowed port naming via runtime reflection.
This meant that .suggestName and other naming APIs do not work. It also
breaks FlatIO for ExtModule which is a potential replacement API for
BlackBox's special `val io` handling.

(cherry picked from commit 83cccfb7

)

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

(cherry picked from commit a1e3a6b5

)

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

(cherry picked from commit 77a6c935

)

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

(cherry picked from commit 68510515

)

Co-authored-by: Gonsolo <gonsolo@gmail.com>

These methods will start using def macros and since def macros do not
supported named arguments this will be a source-incompatible change.
This deprecation will warn users that they need to remove any uses of
named arguments on these methods.

* Update CONTRIBUTING.md with backport cleanup process (#2523)

(cherry picked from commit ac19ff70

)

# Conflicts:
#	CONTRIBUTING.md

* Resolve conflicts

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

* Support separately elaborating definition and instance in ChiselStage (#2512)

(cherry picked from commit a0aa4d15

)

# Conflicts:
#	core/src/main/scala/chisel3/experimental/hierarchy/Definition.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/Instance.scala
#	core/src/main/scala/chisel3/internal/Builder.scala

* fixing imports (#2522)

Co-authored-by: Deborah Soung <debs@sifive.com>

For traits or abstract classes that extend Bundle but have no concrete
methods, the plugin will print a benign warning that the user cannot
fix. It will no longer print that warning.

(cherry picked from commit ed4a9818

)

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

(cherry picked from commit f9aee1f7

)

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

In Scala 2.13, Auto-application to `()` is deprecated. Any nullary
method (ie. a method with no arguments) that is defined with () must now
be called with (). @chiselName used to inject a case of this warning
into user code which would then cause a warning on the @chiselName macro
that the user has no way to fix.

(cherry picked from commit ca902680

)

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

The difference in logic depth for various paths now has a maximum of 1.

Also make treeReduce order the same for 2.12 and 2.13

.grouped(_) returns an Iterator
.toSeq on an Iterator returns a Stream in 2.12 and a List in 2.13
This can lead to changes in order when bumping from 2.12 to 2.13 that
can be avoided by simply using an eager collection explicitly.

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

)

Co-authored-by: Martin Schoeberl <martin@jopdesign.com>

Fixes #2470

(cherry picked from commit 44165a25

)

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

This is a quick fix for issue #2408

(cherry picked from commit d4ef9a96

)

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

(cherry picked from commit 52165fe2

)

Co-authored-by: Lucheng Zhang <79909456+geekLucian@users.noreply.github.com>

(cherry picked from commit d6a357d2

)

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

Loosen restrictions on clocks to enable them to be connected to
DontCare, i.e., be invalidated.

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

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

)

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

* Use a single field instead of two in HasId (4-bytes per HasId)
* Set the prefix to Nil after setting ref to free up memory

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

)

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

* Capture 1:1 mappings of Aggregates inside of views

This is implemented by including any corresponding Aggregates from the
DataView.mapping in the AggregateViewBinding.childMap (which is now of
type Map[Data, Data]).

This enables dynamically indexing Vecs that are themselves elements of
larger Aggregates in views when the corresponding element of the view is
a Vec of the same type. It also increases the number of cases where a
single Target can represent part of a view.

(cherry picked from commit 1f6b1ca1)

* Add FlatIO API for creating ports from Bundles without a prefix

(cherry picked from commit 772a3a1f)

* [docs] Add FlatIO to the general cookbook

(cherry picked from commit b4159641

)

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

* During sanitize, only filter the String if needed
* Do not recurse on name, saving an unnecessary call to sanitize

(cherry picked from commit 559b3df3

)

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

(cherry picked from commit 3940136b

)

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

(cherry picked from commit 4da1e89f

)

Co-authored-by: fzi-hielscher <47524191+fzi-hielscher@users.noreply.github.com>

This reduces memory use of every HasId by 64 bytes.

Every instance of HasId (including all Data) had 2 ListBuffer vals for
recording post-naming hooks, yet this feature is almost never used.
These are now vars of type List which allows the common case of Nil to
add no incremental memory use per instance of HasId.

(cherry picked from commit cf410180

)

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