Class/Object

Chisel

Pipe

Related Docs: object Pipe | package Chisel

Permalink

class Pipe[T <: Data] extends Module

A hardware module that delays data coming down the pipeline by the number of cycles set by the latency parameter. Functionality is similar to ShiftRegister but this exposes a Pipe interface.

Source
ChiselUtil.scala
Example:
  1. val pipe = new Pipe(UInt())
    pipe.io.enq <> produce.io.out
    consumer.io.in <> pipe.io.deq
Linear Supertypes
Module, Nameable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pipe
  2. Module
  3. Nameable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Type Members

  1. type neededWireWraps = HashMap[StackTraceElement, ArrayBuffer[Data]]

    Permalink

    verifyWireWrap (Chisel3) - verify assignment semantics (type-only nodes must be wire-wrapped)

    verifyWireWrap (Chisel3) - verify assignment semantics (type-only nodes must be wire-wrapped)

    returns

    - HashMap of source lines (and associated nodes) requiring Wire() wrapping.

    Definition Classes
    Module

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <>(src: Module): Unit

    Permalink

    Connect io with matching names for two modules

    Connect io with matching names for two modules

    Definition Classes
    Module
  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Module
  6. var _clock: Option[Clock]

    Permalink
    Definition Classes
    Module
  7. def addClock(clock: Clock): Unit

    Permalink

    Add a clock to the module

    Add a clock to the module

    clock

    the clock to add

    Definition Classes
    Module
  8. def addDefaultReset: Unit

    Permalink

    Add a default reset to the module

    Add a default reset to the module

    Definition Classes
    Module
  9. def addModule[T <: Module](c: ⇒ T)(implicit p: Parameters = params): T

    Permalink

    Add a submodule to this module

    Add a submodule to this module

    Definition Classes
    Module
  10. def addModule[T <: Module](c: ⇒ T, f: PartialFunction[Any, Any]): T

    Permalink

    Add a submodule to this module

    Add a submodule to this module

    Definition Classes
    Module
  11. def addNode[T <: Node](node: T): T

    Permalink
    Definition Classes
    Module
  12. def addPin[T <: Data](pin: T, name: String = ""): T

    Permalink

    Add a pin with a name to the module

    Add a pin with a name to the module

    pin

    the I/O to add

    name

    A name for the pin

    Definition Classes
    Module
  13. def addResetPin(r: Bool): Bool

    Permalink

    returns

    the pin connected to the reset signal or creates a new one if no such pin exists

    Definition Classes
    Module
  14. def apply(name: String): Data

    Permalink
    Definition Classes
    Module
  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  16. def assert(cond: Bool, message: String = ""): Unit

    Permalink

    Add an assertion in the code generated by a backend.

    Add an assertion in the code generated by a backend.

    Definition Classes
    Module
  17. def bfs(visit: (Node) ⇒ Unit): Unit

    Permalink

    A breadth first search of the graph of nodes

    A breadth first search of the graph of nodes

    Definition Classes
    Module
  18. val children: ArrayBuffer[Module]

    Permalink
    Definition Classes
    Module
  19. def clock: Clock

    Permalink

    returns

    the implied clock for this module

    Definition Classes
    Module
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def debug(data: Aggregate): Unit

    Permalink
    Definition Classes
    Module
  22. def debug(x: Node): Unit

    Permalink

    Insures a backend does not remove a signal because it is unreachable from the outputs.

    Insures a backend does not remove a signal because it is unreachable from the outputs.

    Definition Classes
    Module
  23. def dfs(visit: (Node) ⇒ Unit): Unit

    Permalink

    A depth first search of the graph of nodes

    A depth first search of the graph of nodes

    Definition Classes
    Module
  24. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Module → AnyRef → Any
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def findBinding(m: Node): Option[Binding]

    Permalink

    A method to trace the graph of nodes backwards looking at inputs

    A method to trace the graph of nodes backwards looking at inputs

    m

    Node to find bindings for

    returns

    nodes which have node m binded as their input

    Definition Classes
    Module
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def getPathName(separator: String = "_"): String

    Permalink

    separator

    The separator to use for the path name

    returns

    the absolute path to a component instance from toplevel

    Definition Classes
    Module
  30. def getPathName: String

    Permalink

    returns

    the absolute path to a component instance from toplevel

    Definition Classes
    Module
  31. val hashCode: Int

    Permalink
    Definition Classes
    Module → AnyRef → Any
  32. val io: Bundle { ... /* 2 definitions in type refinement */ }

    Permalink

    the I/O for this module

    the I/O for this module

    Definition Classes
    PipeModule
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. var moduleName: String

    Permalink

    Name of the module this component generates (defaults to class name).

    Name of the module this component generates (defaults to class name).

    Definition Classes
    Module
  35. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  36. var named: Boolean

    Permalink

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  37. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def nextIndex: Int

    Permalink
    Definition Classes
    Module
  39. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  41. lazy val params: Parameters

    Permalink
    Definition Classes
    Module
  42. var parent: Module

    Permalink
    Definition Classes
    Module
  43. def printf(message: String, args: Node*): Unit

    Permalink

    Adds a printf to the module called each clock cycle

    Adds a printf to the module called each clock cycle

    message

    A c style sting to print out eg) %d, %x

    args

    Nodes whos data values should be printed

    Definition Classes
    Module
  44. def reset: Bool

    Permalink

    returns

    the implied reset for this module

    Definition Classes
    Module
  45. def setModuleName(n: String): Unit

    Permalink

    Set the declaration name of the module to be string 'n'

    Set the declaration name of the module to be string 'n'

    Definition Classes
    Module
  46. def setName(n: String): Unit

    Permalink

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  47. def stripComponent(s: String): String

    Permalink
    Definition Classes
    Module
  48. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. def wires: Array[(String, Bits)]

    Permalink

    Get the I/O names and connections

    Get the I/O names and connections

    Definition Classes
    Module

Inherited from Module

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped