Class/Object

chisel3.util

Pipe

Related Docs: object Pipe | package util

Permalink

class Pipe[T <: Data] extends Module

Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pipe
  2. LegacyModule
  3. ImplicitModule
  4. UserModule
  5. BaseModule
  6. HasId
  7. InstanceId
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Pipe(gen: T, latency: Int = 1)(implicit compileOptions: CompileOptions)

    Permalink

Type Members

  1. class PipeIO extends Bundle

    Permalink

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 <: core.Data](iodef: T): iodef.type

    Permalink

    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 WILL NOT be cloned (to allow for more seamless use of anonymous Bundles in the IO) and thus CANNOT have been bound to any logic. This will error if any node is bound (e.g. due to logic in a Bundle constructor, which is considered improper).

    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
  5. def _autoWrapPorts(): Unit

    Permalink

    Compatibility function.

    Compatibility function. Allows Chisel2 code which had ports without the IO wrapper to compile under Bindings checks. Does nothing in non-compatibility mode.

    Should NOT be used elsewhere. This API will NOT last.

    TODO: remove this, perhaps by removing Bindings checks in compatibility mode.

    Definition Classes
    BaseModule
  6. var _closed: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  7. def _ioPortBound(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    LegacyModule
  8. def annotate(annotation: ChiselAnnotation): Unit

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

    Permalink
    Definition Classes
    Any
  10. val clock: core.Clock

    Permalink
    Definition Classes
    ImplicitModule
  11. def clone(): AnyRef

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

    Permalink
    Definition Classes
    UserModule
  13. def desiredName: String

    Permalink

    Desired name of this module.

    Desired name of this module. Override this to give this module a custom, perhaps parametric, name.

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    UserModule
  19. def getIds: Seq[HasId]

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

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

    Permalink
    Definition Classes
    UserModule
  22. def hashCode(): Int

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

    Permalink

    Signal name (for simulation).

    Signal name (for simulation).

    Definition Classes
    BaseModule → HasId → InstanceId
  24. val io: PipeIO

    Permalink
    Definition Classes
    PipeLegacyModule
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. final val name: String

    Permalink

    Legalized name of this module.

    Legalized name of this module.

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

    Permalink

    Called at the Module.apply(...) level after this Module has finished elaborating.

    Called at the Module.apply(...) level after this Module has finished elaborating. Returns a map of nodes -> names, for named nodes.

    Helper method.

    Attributes
    protected
    Definition Classes
    LegacyModuleBaseModule
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    BaseModule
  38. val reset: Reset

    Permalink
    Definition Classes
    ImplicitModule
  39. def suggestName(name: ⇒ String): Pipe.this.type

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

    Permalink
    Definition Classes
    AnyRef
  41. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LegacyModule

Inherited from ImplicitModule

Inherited from UserModule

Inherited from BaseModule

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped