Chisel

Module

abstract class Module extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Module
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Module(clock: Clock = null, _reset: Bool = null)

Abstract Value Members

  1. abstract def io: Data

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

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

  8. def addClockAndReset: Unit

  9. def addDefaultReset: Unit

  10. def addResetPin(reset: Bool): Unit

  11. def apply(name: String): Data

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def assert(cond: Bool, message: String): Unit

    Add an assertion in the code generated by a backend.

  14. def bfs(visit: (Node) ⇒ Unit): Unit

  15. val bindings: ArrayBuffer[Binding]

  16. val children: ArrayBuffer[Module]

  17. var clock: Clock

  18. val clocks: ArrayBuffer[Clock]

  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def collectNodes(c: Module): Unit

  21. var containsReg: Boolean

  22. def containsRegInTree: Boolean

    Returns true if this module or any of its children contains at least one register.

  23. def debug(x: Node): Unit

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

  24. val debugs: HashSet[Node]

  25. var defaultResetPin: Bool

  26. var defaultWidth: Int

  27. def depthString(depth: Int): String

  28. def elaborate(fake: Int = 0): Unit

  29. def emitDec(b: Backend): String

  30. final def eq(arg0: AnyRef): Boolean

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

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

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

  34. def findCombLoop(): Unit

  35. def findConsumers(): Unit

  36. def findGraphDims(): (Int, Int, Int)

  37. def findOrdering(): Unit

  38. def findRoots(): ArrayBuffer[Node]

    Since we are relying on the out-degree of nodes (i.

    Since we are relying on the out-degree of nodes (i.e. consumers.length), this method should only be called after the forward edges have been constructed.

  39. def forceMatchingWidths: Unit

  40. def genAllMuxes: Unit

  41. final def getClass(): Class[_]

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

  43. def getPathName: String

    Returns the absolute path to a component instance from toplevel.

  44. def getResetPin(reset: Bool): Bool

  45. def hasClock: Boolean

  46. var hasExplicitClock: Boolean

  47. var hasExplicitReset: Boolean

  48. def hasReset: Boolean

  49. def hasWhenCond: Boolean

  50. val hashCode: Int

    Definition Classes
    Module → AnyRef → Any
  51. def inferAll(): Int

  52. def initializeBFS: scala.collection.mutable.Queue[Node]

  53. def initializeDFS: Stack[Node]

  54. var ioVal: Data

  55. def isInferenceTerminal(m: Node): Boolean

  56. def isInput(node: Node): Boolean

  57. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  58. def isSubclassOf(x: Class[_]): Boolean

  59. var isWalked: HashSet[Node]

  60. var isWalking: HashSet[Node]

  61. def keepInputs(nodes: Seq[Node]): Seq[Node]

  62. var level: Int

    A backend(Backend.

    A backend(Backend.scala) might generate multiple module source code from one Module, based on the parameters to instanciate the component instance. Since we do not want to blindly generate one module per instance the backend will keep a cache of each module's implementation source code and discard textual duplicates. By walking the nodes from level zero (leafs) to level N (root), we are guarenteed to generate all Module/modules source text before their first instantiation.

  63. def markComponent(): Unit

  64. val mods: ArrayBuffer[Node]

  65. var moduleName: String

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

  66. var name: String

    Name of the instance.

  67. var named: Boolean

  68. val names: HashMap[String, Node]

  69. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  70. def nextIndex: Int

  71. val nexts: scala.collection.mutable.Queue[Node]

  72. var nindex: Int

  73. val nodes: ArrayBuffer[Node]

  74. final def notify(): Unit

    Definition Classes
    AnyRef
  75. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  76. val omods: ArrayBuffer[Node]

  77. def ownIo(): Unit

  78. var parent: Module

  79. var pathParent: Module

  80. def postMarkNet(fake: Int = 0): Unit

  81. def printf(message: String, args: Node*): Unit

  82. val regs: ArrayBuffer[Reg]

  83. def removeInputs(nodes: Seq[Node]): Seq[Node]

  84. def removeTypeNodes(): Int

    All classes inherited from Data are used to add type information and do not represent logic itself.

  85. def reset: Bool

  86. def reset_=(): Unit

  87. def reset_=(r: Bool): Unit

  88. val resets: HashMap[Bool, Bool]

  89. def stripComponent(s: String): String

  90. val switchKeys: Stack[Bits]

  91. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  92. def toString(): String

    Definition Classes
    Module → AnyRef → Any
  93. def traceNodes(): Unit

  94. def traceableNodes: Array[Node]

  95. var traversal: Int

  96. def verifyAllMuxes: Unit

  97. var verilog_parameters: String

  98. def visitNodes(roots: Array[Node]): Unit

  99. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. def whenCond: Bool

  103. val whenConds: Stack[Bool]

  104. def wires: Array[(String, Bits)]

  105. var wiresCache: Array[(String, Bits)]

Inherited from AnyRef

Inherited from Any

Ungrouped