From 7930544e9c8047f27285420204d25f78c753ea57 Mon Sep 17 00:00:00 2001 From: Jack Koenig Date: Fri, 8 Oct 2021 09:07:04 -0700 Subject: Add nullary .fire to Valid and deprecate dummy version (#2156) Also replace all uses of .fire() with .fire--- src/main/scala/chisel3/util/random/PRNG.scala | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/main/scala/chisel3/util/random') diff --git a/src/main/scala/chisel3/util/random/PRNG.scala b/src/main/scala/chisel3/util/random/PRNG.scala index d94b78e8..9b42acf1 100644 --- a/src/main/scala/chisel3/util/random/PRNG.scala +++ b/src/main/scala/chisel3/util/random/PRNG.scala @@ -62,7 +62,7 @@ abstract class PRNG(val width: Int, val seed: Option[BigInt], step: Int = 1, upd state := nextState(state) } - when (io.seed.fire()) { + when (io.seed.fire) { state := (if (updateSeed) { nextState(io.seed.bits) } else { io.seed.bits }) } -- cgit v1.2.3 From ffa0831c736c7d5296964bc65536ac256220dcaa Mon Sep 17 00:00:00 2001 From: Nic McDonald Date: Tue, 12 Oct 2021 15:25:55 -0600 Subject: Fix GaloisLFSR comments (#2178) --- src/main/scala/chisel3/util/random/GaloisLFSR.scala | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/main/scala/chisel3/util/random') diff --git a/src/main/scala/chisel3/util/random/GaloisLFSR.scala b/src/main/scala/chisel3/util/random/GaloisLFSR.scala index 0d407c87..68346e82 100644 --- a/src/main/scala/chisel3/util/random/GaloisLFSR.scala +++ b/src/main/scala/chisel3/util/random/GaloisLFSR.scala @@ -13,7 +13,7 @@ import chisel3._ * * $seedExplanation * - * In the example below, a 4-bit LFSR Fibonacci LFSR is constructed. The tap points are defined as four and three + * In the example below, a 4-bit LFSR Galois LFSR is constructed. The tap points are defined as four and three * (using LFSR convention of indexing from one). This results in the hardware configuration shown in the diagram. * * {{{ @@ -85,7 +85,7 @@ class MaxPeriodGaloisLFSR(width: Int, seed: Option[BigInt] = Some(1), reduction: */ object GaloisLFSR { - /** Return a pseudorandom [[UInt]] generated from a [[FibonacciLFSR]]. + /** Return a pseudorandom [[UInt]] generated from a [[GaloisLFSR]]. * $paramWidth * $paramTaps * $paramIncrement -- cgit v1.2.3 From a79f57565e7157d137628d1aaeae750f98e3d88b Mon Sep 17 00:00:00 2001 From: Abongwa Bonalais Date: Wed, 3 Nov 2021 05:56:37 +0100 Subject: Add field grouping ScalaDoc for other subclasses of Bundle (#2214) * Add field grouping scaladocs for DecoupledIo * Added groupdesc to DecoupledIO * Added groupings for IrrevocableIO * Add groupings for ValidIO * Add field grouping scaladoc for PRNGIO * Add field grouping scaladoc for QueueIO * Added groupings for PipeIO * Update src/main/scala/chisel3/util/Decoupled.scala Commited Sugestion Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Decoupled.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Decoupled.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Decoupled.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Decoupled.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Valid.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Valid.scala Co-authored-by: Megan Wachs * Update src/main/scala/chisel3/util/Valid.scala Co-authored-by: Megan Wachs Co-authored-by: Megan Wachs --- src/main/scala/chisel3/util/random/PRNG.scala | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'src/main/scala/chisel3/util/random') diff --git a/src/main/scala/chisel3/util/random/PRNG.scala b/src/main/scala/chisel3/util/random/PRNG.scala index 9b42acf1..3a44385a 100644 --- a/src/main/scala/chisel3/util/random/PRNG.scala +++ b/src/main/scala/chisel3/util/random/PRNG.scala @@ -7,16 +7,23 @@ import chisel3.util.Valid /** Pseudo Random Number Generators (PRNG) interface * @param n the width of the LFSR + * @groupdesc Signals The actual hardware fields of the Bundle */ class PRNGIO(val n: Int) extends Bundle { - /** A [[chisel3.util.Valid Valid]] interface that can be used to set the seed (internal PRNG state) */ + /** A [[chisel3.util.Valid Valid]] interface that can be used to set the seed (internal PRNG state) + * @group Signals + */ val seed: Valid[Vec[Bool]] = Input(Valid(Vec(n, Bool()))) - /** When asserted, the PRNG will increment by one */ + /** When asserted, the PRNG will increment by one + * @group Signals + */ val increment: Bool = Input(Bool()) - /** The current state of the PRNG */ + /** The current state of the PRNG + * @group Signals + */ val out: Vec[Bool] = Output(Vec(n, Bool())) } -- cgit v1.2.3