class Arbiter[T <: Data] extends Module

Hardware module that is used to sequence n producers into 1 consumer. Priority is given to lower producer.

Source
Arbiter.scala
Example:
  1. val arb = Module(new Arbiter(UInt(), 2))
    arb.io.in(0) <> producer0.io.out
    arb.io.in(1) <> producer1.io.out
    consumer.io.in <> arb.io.out
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Arbiter
  2. Module
  3. RawModule
  4. BaseModule
  5. IsInstantiable
  6. HasId
  7. InstanceId
  8. AnyRef
  9. Any
Implicitly
  1. by BaseModuleExtensions
  2. by IsInstantiableExtensions
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Arbiter(gen: T, n: Int)

    gen

    data type

    n

    number of inputs

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toany2stringadd[Arbiter[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Arbiter[T], B)
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toArrowAssoc[Arbiter[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def IO[T <: Data](iodef: => T)(implicit sourceInfo: SourceInfo): T

    This must wrap the datatype used to set the io field of any Module.

    This must wrap the datatype used to set the io field of any Module. i.e. All concrete modules must have defined io in this form: [lazy] val io[: io type] = IO(...[: io type])

    Items in [] are optional.

    The granted iodef must be a chisel type and not be bound to hardware.

    Also registers a Data as a port, also performing bindings. Cannot be called once ports are requested (so that all calls to ports will return the same information). Internal API.

    TODO(twigg): Specifically walk the Data definition to call out which nodes are problematic.

    Attributes
    protected
    Definition Classes
    BaseModule
  7. def _bindIoInPlace(iodef: Data)(implicit sourceInfo: SourceInfo): Unit

    Chisel2 code didn't require the IO(...) wrapper and would assign a Chisel type directly to io, then do operations on it.

    Chisel2 code didn't require the IO(...) wrapper and would assign a Chisel type directly to io, then do operations on it. This binds a Chisel type in-place (mutably) as an IO.

    Attributes
    protected
    Definition Classes
    BaseModule
  8. var _closed: Boolean
    Attributes
    protected
    Definition Classes
    BaseModule
  9. def _moduleDefinitionIdentifierProposal: String
    Attributes
    protected
    Definition Classes
    BaseModule
  10. def _traitModuleDefinitionIdentifierProposal: Option[String]
    Attributes
    protected
    Definition Classes
    BaseModule
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  13. final val clock: Clock
    Definition Classes
    Module
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. final val definitionIdentifier: String

    Represents an eagerly-determined unique and descriptive identifier for this module

    Represents an eagerly-determined unique and descriptive identifier for this module

    Definition Classes
    BaseModule
  16. def desiredName: String

    Give this Arbiter a default, stable desired name using the supplied Data generator's typeName and input count parameter

    Give this Arbiter a default, stable desired name using the supplied Data generator's typeName and input count parameter

    Definition Classes
    ArbiterBaseModule
  17. def ensuring(cond: (Arbiter[T]) => Boolean, msg: => Any): Arbiter[T]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toEnsuring[Arbiter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Arbiter[T]) => Boolean): Arbiter[T]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toEnsuring[Arbiter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): Arbiter[T]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toEnsuring[Arbiter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Arbiter[T]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toEnsuring[Arbiter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. val gen: T
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getCommands: Seq[Command]
    Attributes
    protected
    Definition Classes
    RawModule
  27. def getModulePorts: Seq[Data]
    Attributes
    protected[chisel3]
    Definition Classes
    BaseModule
  28. val grant: Seq[Bool]
  29. def hasSeed: Boolean

    returns

    Whether either autoName or suggestName has been called

    Definition Classes
    HasId
  30. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  31. def instanceName: String

    Signal name (for simulation).

    Signal name (for simulation).

    Definition Classes
    BaseModule → HasId → InstanceId
  32. val io: ArbiterIO[T]
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. val n: Int
  35. final lazy val name: String

    Legalized name of this module.

    Legalized name of this module.

    Definition Classes
    BaseModule
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def parentModName: String
    Definition Classes
    HasId → InstanceId
  40. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  41. def pathName: String
    Definition Classes
    HasId → InstanceId
  42. def portsContains(elem: Data): Boolean
    Attributes
    protected
    Definition Classes
    BaseModule
  43. def portsSize: Int
    Attributes
    protected
    Definition Classes
    BaseModule
  44. final val reset: Reset
    Definition Classes
    Module
  45. def resetType: Type

    Override this to explicitly set the type of reset you want on this module , before any reset inference

    Override this to explicitly set the type of reset you want on this module , before any reset inference

    Definition Classes
    Module
  46. def suggestName(seed: => String): Arbiter.this.type

    Takes the first seed suggested.

    Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.

    Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.

    seed

    The seed for the name of this component

    returns

    this object

    Definition Classes
    HasId
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. final def toAbsoluteTarget: IsModule

    Returns a FIRRTL ModuleTarget that references this object

    Returns a FIRRTL ModuleTarget that references this object

    Definition Classes
    BaseModuleInstanceId
    Note

    Should not be called until circuit elaboration is complete

  49. def toDefinition: Definition[Arbiter[T]]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toBaseModuleExtensions[Arbiter[T]] performed by method BaseModuleExtensions in chisel3.experimental.BaseModule.
    Definition Classes
    BaseModuleExtensions
  50. final def toNamed: ModuleName

    Returns a FIRRTL ModuleName that references this object

    Returns a FIRRTL ModuleName that references this object

    Definition Classes
    BaseModuleInstanceId
    Note

    Should not be called until circuit elaboration is complete

  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. final def toTarget: ModuleTarget

    Returns a FIRRTL ModuleTarget that references this object

    Returns a FIRRTL ModuleTarget that references this object

    Definition Classes
    BaseModuleInstanceId
    Note

    Should not be called until circuit elaboration is complete

  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Shadowed Implicit Value Members

  1. def toInstance: Instance[Arbiter[T]]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toBaseModuleExtensions[Arbiter[T]] performed by method BaseModuleExtensions in chisel3.experimental.BaseModule.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (arbiter: BaseModuleExtensions[Arbiter[T]]).toInstance
    Definition Classes
    BaseModuleExtensions
  2. def toInstance: Instance[Arbiter[T]]
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toIsInstantiableExtensions[Arbiter[T]] performed by method IsInstantiableExtensions in chisel3.experimental.hierarchy.core.IsInstantiable.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (arbiter: IsInstantiableExtensions[Arbiter[T]]).toInstance
    Definition Classes
    IsInstantiableExtensions

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toStringFormat[Arbiter[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def override_clock: Option[Clock]
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  3. def override_clock_=(rhs: Option[Clock]): Unit
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  4. def override_reset: Option[Bool]
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  5. def override_reset_=(rhs: Option[Bool]): Unit
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  6. def [B](y: B): (Arbiter[T], B)
    Implicit
    This member is added by an implicit conversion from Arbiter[T] toArrowAssoc[Arbiter[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Module

Inherited from RawModule

Inherited from BaseModule

Inherited from IsInstantiable

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BaseModuleExtensions fromArbiter[T] to BaseModuleExtensions[Arbiter[T]]

Inherited by implicit conversion IsInstantiableExtensions fromArbiter[T] to IsInstantiableExtensions[Arbiter[T]]

Inherited by implicit conversion any2stringadd fromArbiter[T] to any2stringadd[Arbiter[T]]

Inherited by implicit conversion StringFormat fromArbiter[T] to StringFormat[Arbiter[T]]

Inherited by implicit conversion Ensuring fromArbiter[T] to Ensuring[Arbiter[T]]

Inherited by implicit conversion ArrowAssoc fromArbiter[T] to ArrowAssoc[Arbiter[T]]

Ungrouped