Deprecate TransitName (backport #2603) (#2606)

* Deprecate TransitName (#2603)

* Deprecate TransitName
* Add @nowarn macros to usages of TransitName in the repo

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

* Update src/main/scala/chisel3/util/Valid.scala

* Update src/main/scala/chisel3/util/Valid.scala

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

3 files changed, 17 insertions, 0 deletions

diff --git a/src/main/scala/chisel3/util/Decoupled.scala b/src/main/scala/chisel3/util/Decoupled.scala
index 5c71a4ea..42717b66 100644
--- a/src/main/scala/chisel3/util/Decoupled.scala
+++ b/src/main/scala/chisel3/util/Decoupled.scala
@@ -9,6 +9,8 @@ import chisel3._
 import chisel3.experimental.{requireIsChiselType, DataMirror, Direction}
 import chisel3.internal.naming._ // can't use chisel3_ version because of compile order
 
+import scala.annotation.nowarn
+
 /** An I/O Bundle containing 'valid' and 'ready' signals that handshake
   * the transfer of data stored in the 'bits' subfield.
   * The base protocol implied by the directionality is that
@@ -342,6 +344,7 @@ object Queue {
     *   consumer.io.in <> Queue(producer.io.out, 16)
     * }}}
     */
+  @nowarn("cat=deprecation&msg=TransitName")
   @chiselName
   def apply[T <: Data](
     enq:            ReadyValidIO[T],
diff --git a/src/main/scala/chisel3/util/TransitName.scala b/src/main/scala/chisel3/util/TransitName.scala
index cc8f2456..8b509db5 100644
--- a/src/main/scala/chisel3/util/TransitName.scala
+++ b/src/main/scala/chisel3/util/TransitName.scala
@@ -42,6 +42,12 @@ object TransitName {
     * @param to the thing that will receive the "good" name
     * @return the `from` parameter
     */
+  @deprecated(
+    "Use suggestName or rely on the naming plugin instead of this function: \n" +
+      "  val from = {to}\n" +
+      "  val from = prefix(prefixYouWant){to}",
+    "Chisel 3.5.4"
+  )
   def apply[T <: HasId](from: T, to: HasId): T = {
     // To transit a name, we need to hook on both the suggestName and autoSeed mechanisms
     from.addSuggestPostnameHook((given_name: String) => { to.suggestName(given_name) })
@@ -55,6 +61,11 @@ object TransitName {
     * @param to the thing that will receive the "good" name
     * @return the `from` parameter
     */
+  @deprecated(
+    "Use suggestName or rely on the naming plugin instead of this function. Use prefix instead of suffix: \n" +
+      "  val from = prefix(prefixYouWant){to}",
+    "Chisel 3.5.4"
+  )
   def withSuffix[T <: HasId](suffix: String)(from: T, to: HasId): T = {
     // To transit a name, we need to hook on both the suggestName and autoSeed mechanisms
     from.addSuggestPostnameHook((given_name: String) => { to.suggestName(given_name + suffix) })
diff --git a/src/main/scala/chisel3/util/Valid.scala b/src/main/scala/chisel3/util/Valid.scala
index eeb2ab68..cb0e166a 100644
--- a/src/main/scala/chisel3/util/Valid.scala
+++ b/src/main/scala/chisel3/util/Valid.scala
@@ -7,6 +7,8 @@ package chisel3.util
 
 import chisel3._
 
+import scala.annotation.nowarn
+
 /** A [[Bundle]] that adds a `valid` bit to some data. This indicates that the user expects a "valid" interface between
   * a producer and a consumer. Here, the producer asserts the `valid` bit when data on the `bits` line contains valid
   * data. This differs from [[DecoupledIO]] or [[IrrevocableIO]] as there is no `ready` line that the consumer can use
@@ -116,6 +118,7 @@ object Pipe {
     * @param latency the number of pipeline stages
     * @return $returnType
     */
+  @nowarn("cat=deprecation&msg=TransitName")
   def apply[T <: Data](enqValid: Bool, enqBits: T, latency: Int)(implicit compileOptions: CompileOptions): Valid[T] = {
     require(latency >= 0, "Pipe latency must be greater than or equal to zero!")
     if (latency == 0) {