Trait/Object

chisel3.util.random

LFSR

Related Docs: object LFSR | package random

Permalink

trait LFSR extends PRNG

Trait that defines a Linear Feedback Shift Register (LFSR).

If the user specifies a seed, then a compile-time check is added that they are not initializing the LFSR to a state which will cause it to lock up. If the user does not set a seed, then the least significant bit of the state will be set or reset based on the choice of reduction operator.

Source
LFSR.scala
See also

https://en.wikipedia.org/wiki/Linear-feedback_shift_register

GaloisLFSR

FibonacciLFSR

Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LFSR
  2. PRNG
  3. LegacyModule
  4. MultiIOModule
  5. RawModule
  6. BaseModule
  7. HasId
  8. InstanceId
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def delta(s: Seq[Bool]): Seq[Bool]

    Permalink

    State update function

    State update function

    s

    input state

    returns

    the next state

    Definition Classes
    PRNG
  2. abstract def reduction: LFSRReduce

    Permalink

    The binary reduction operation used by this LFSR, either XOR or XNOR.

    The binary reduction operation used by this LFSR, either XOR or XNOR. This has the effect of mandating what seed is invalid.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def IO[T <: Data](iodef: T): T

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  5. def _bindIoInPlace(iodef: Data): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  6. var _closed: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  7. def _compatAutoWrapPorts(): Unit

    Permalink
    Definition Classes
    BaseModule
  8. def _compatIoPortBound(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    LegacyModule
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def circuitName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasId
  11. final val clock: Clock

    Permalink
    Definition Classes
    MultiIOModule
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val compileOptions: CompileOptions

    Permalink
    Definition Classes
    RawModule
  14. def desiredName: String

    Permalink
    Definition Classes
    BaseModule
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getCommands: Seq[Command]

    Permalink
    Attributes
    protected
    Definition Classes
    RawModule
  20. def getIds: Seq[HasId]

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  21. def getModulePorts: Seq[Data]

    Permalink
    Attributes
    protected[chisel3]
    Definition Classes
    BaseModule
  22. lazy val getPorts: Seq[Port]

    Permalink
    Definition Classes
    RawModule
  23. def hashCode(): Int

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  24. def instanceName: String

    Permalink
    Definition Classes
    BaseModule → HasId → InstanceId
  25. val io: PRNGIO

    Permalink
    Definition Classes
    PRNG → LegacyModule
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. final lazy val name: String

    Permalink
    Definition Classes
    BaseModule
  28. def nameIds(rootClass: Class[_]): HashMap[HasId, String]

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def nextState(s: Seq[Bool]): Seq[Bool]

    Permalink

    The method that will be used to update the state of this PRNG

    The method that will be used to update the state of this PRNG

    s

    input state

    returns

    the next state after step applications of PRNG.delta

    Definition Classes
    PRNG
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. var override_clock: Option[Clock]

    Permalink
    Attributes
    protected
    Definition Classes
    LegacyModule
  34. var override_reset: Option[Bool]

    Permalink
    Attributes
    protected
    Definition Classes
    LegacyModule
  35. def parentModName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  36. def parentPathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  37. def pathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  38. def portsContains(elem: Data): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  39. def portsSize: Int

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  40. final val reset: Reset

    Permalink
    Definition Classes
    MultiIOModule
  41. def resetValue: Vec[Bool]

    Permalink

    Allow implementations to override the reset value, e.g., if some bits should be don't-cares.

    Allow implementations to override the reset value, e.g., if some bits should be don't-cares.

    Attributes
    protected
    Definition Classes
    LFSRPRNG
  42. val seed: Option[BigInt]

    Permalink

    the initial state of the PRNG

    the initial state of the PRNG

    Definition Classes
    PRNG
  43. def suggestName(name: ⇒ String): LFSR.this.type

    Permalink
    Definition Classes
    HasId
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. final def toAbsoluteTarget: IsModule

    Permalink
    Definition Classes
    BaseModule → InstanceId
  46. final def toNamed: ModuleName

    Permalink
    Definition Classes
    BaseModule → InstanceId
  47. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  48. final def toTarget: ModuleTarget

    Permalink
    Definition Classes
    BaseModule → InstanceId
  49. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. val width: Int

    Permalink

    the width of the PRNG

    the width of the PRNG

    Definition Classes
    PRNG

Inherited from PRNG

Inherited from LegacyModule

Inherited from MultiIOModule

Inherited from RawModule

Inherited from BaseModule

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped