From 3f8743b48dd3ecc1c766a18bc9c5cc8b285e0355 Mon Sep 17 00:00:00 2001 From: Abongwa Bonalais <81782853+Burnleydev1@users.noreply.github.com> Date: Thu, 28 Oct 2021 07:58:08 +0100 Subject: [PATCH] Add field grouping ScalaDoc for DecoupledIO --- src/main/scala/chisel3/util/Decoupled.scala | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/main/scala/chisel3/util/Decoupled.scala b/src/main/scala/chisel3/util/Decoupled.scala index 84c850ec653..d73ce7b2f07 100644 --- a/src/main/scala/chisel3/util/Decoupled.scala +++ b/src/main/scala/chisel3/util/Decoupled.scala @@ -26,8 +26,19 @@ abstract class ReadyValidIO[+T <: Data](gen: T) extends Bundle case _ => gen } +/** indicates that the consumer is ready to accept the data this cycle + * @group Signals + */ val ready = Input(Bool()) + +/** indicates that the producer has put valid data in 'bits' + * @group Signals + */ val valid = Output(Bool()) + +/** Data stored in the 'bits' subfield + * @group Signals + */ val bits = Output(genType) }