Add more information when probe types don't match (#4269)

(cherry picked from commit 029254a)
chipsalliance · Jul 10, 2024 · 9dc1471 · 9dc1471
1 parent 52746eb
commit 9dc1471
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/core/src/main/scala/chisel3/probe/package.scala b/core/src/main/scala/chisel3/probe/package.scala
@@ -33,8 +33,14 @@ package object probe extends SourceInfoDoc {
     * @param probeExpr value to initialize the sink to
     */
   def define[T <: Data](sink: T, probeExpr: T)(implicit sourceInfo: SourceInfo): Unit = {
-    if (!sink.typeEquivalent(probeExpr, false /* we will check more more detailed probe info below */ )) {
-      Builder.error("Cannot define a probe on a non-equivalent type.")
+    val typeCheckResult = sink.findFirstTypeMismatch(
+      probeExpr,
+      strictTypes = true,
+      strictWidths = true,
+      strictProbeInfo = false /* we will check more more detailed probe info below */
+    )
+    typeCheckResult.foreach { msg =>
+      Builder.error(s"Cannot define a probe on a non-equivalent type.\n$msg")
     }
     requireHasProbeTypeModifier(sink, "Expected sink to be a probe.")
     requireNotChildOfProbe(sink, "Expected sink to be the root of a probe.")

diff --git a/src/test/scala/chiselTests/ProbeSpec.scala b/src/test/scala/chiselTests/ProbeSpec.scala
@@ -353,6 +353,10 @@ class ProbeSpec extends ChiselFlatSpec with Utils {
       )
     }
     exc.getMessage should include("Cannot define a probe on a non-equivalent type.")
+    exc.getMessage should include(
+      "Left (ProbeSpec_Anon.p: IO[UInt<4>]) and Right (ProbeSpec_Anon.Node(ProbeSpec_Anon.w: Wire[Bool]): OpResult[Bool]) have different types"
+    )
+
   }
 
   "Probe of a probe type" should "fail" in {