summaryrefslogtreecommitdiff
path: root/src/main/scala
diff options
context:
space:
mode:
authorJack Koenig2020-06-22 12:32:36 -0700
committerGitHub2020-06-22 19:32:36 +0000
commit28e1a244bcc75a1138d25f5aa43ef22e23ef3ed7 (patch)
tree66f5512ccfa0c18c0f3d89efabb37c2c273da34e /src/main/scala
parent1692b8a1c25fab175d4dff200ed3b15b22260edf (diff)
Canonicalize construction of Decoupled with no payload (#785)
* Canonicalize construction of empty Decoupled * Change signature after dev meeting discussion * Make EmptyBundle private and final * Add test case for Decoupled with no payload * Apply suggestions from code review Co-authored-by: Richard Lin <richard.lin@berkeley.edu> Co-authored-by: Albert Magyar <albert.magyar@gmail.com> Co-authored-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> Co-authored-by: Adam Izraelevitz <azidar@gmail.com> Co-authored-by: Richard Lin <richard.lin@berkeley.edu> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Diffstat (limited to 'src/main/scala')
-rw-r--r--src/main/scala/chisel3/util/Decoupled.scala9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/main/scala/chisel3/util/Decoupled.scala b/src/main/scala/chisel3/util/Decoupled.scala
index 6a3aad24..82511ee5 100644
--- a/src/main/scala/chisel3/util/Decoupled.scala
+++ b/src/main/scala/chisel3/util/Decoupled.scala
@@ -92,6 +92,15 @@ object Decoupled
/** Wraps some Data with a DecoupledIO interface. */
def apply[T <: Data](gen: T): DecoupledIO[T] = new DecoupledIO(gen)
+ // TODO: use a proper empty data type, this is a quick and dirty solution
+ private final class EmptyBundle extends Bundle
+
+ // Both of these methods return DecoupledIO parameterized by the most generic type: Data
+ /** Returns a [[DecoupledIO]] inteface with no payload */
+ def apply(): DecoupledIO[Data] = apply(new EmptyBundle)
+ /** Returns a [[DecoupledIO]] inteface with no payload */
+ def empty: DecoupledIO[Data] = Decoupled()
+
/** Downconverts an IrrevocableIO output to a DecoupledIO, dropping guarantees of irrevocability.
*
* @note unsafe (and will error) on the producer (input) side of an IrrevocableIO