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. val asserts: ArrayBuffer[Assert]

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

  16. val bindings: ArrayBuffer[Binding]

  17. val children: ArrayBuffer[Module]

  18. var clock: Clock

  19. val clocks: ArrayBuffer[Clock]

  20. def clone(): AnyRef

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

  22. var containsReg: Boolean

  23. def containsRegInTree: Boolean

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

  24. def counter(xs: Node*): Unit

  25. def counter(x: Node): Unit

  26. def debug(x: Node): Unit

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

  27. val debugs: LinkedHashSet[Node]

  28. var defaultResetPin: Bool

  29. var defaultWidth: Int

  30. def depthString(depth: Int): String

  31. def dfs(visit: (Node) ⇒ Unit): Unit

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

  33. def emitDec(b: Backend): String

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

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

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

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

  38. def findCombLoop(): Unit

  39. def findConsumers(): Unit

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

  41. def findOrdering(): Unit

  42. 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.

  43. def forceMatchingWidths: Unit

  44. def genAllMuxes: Unit

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

    Definition Classes
    AnyRef → Any
  46. def getClassValNames(c: Class[_]): ArrayBuffer[String]

  47. def getPathName(separator: String = "_"): String

  48. def getPathName: String

    Returns the absolute path to a component instance from toplevel.

  49. def getResetPin(reset: Bool): Bool

  50. def getValNames: ArrayBuffer[String]

  51. def hasClock: Boolean

  52. var hasExplicitClock: Boolean

  53. var hasExplicitReset: Boolean

  54. def hasReset: Boolean

  55. def hasWhenCond: Boolean

  56. val hashCode: Int

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

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

  59. def initializeDFS: Stack[Node]

  60. var ioVal: Data

  61. def isInferenceTerminal(m: Node): Boolean

  62. def isInput(node: Node): Boolean

  63. final def isInstanceOf[T0]: Boolean

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

  65. object isValName

  66. var isWalked: HashSet[Node]

  67. var isWalking: HashSet[Node]

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

  69. 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.

  70. def markComponent(): Unit

  71. val mods: ArrayBuffer[Node]

  72. var moduleName: String

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

  73. var name: String

    Name of the instance.

  74. var named: Boolean

  75. val names: HashMap[String, Node]

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

    Definition Classes
    AnyRef
  77. def nextIndex: Int

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

  79. var nindex: Int

  80. val nodes: ArrayBuffer[Node]

  81. final def notify(): Unit

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

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

  84. def ownIo(): Unit

  85. var pName: String

  86. var parent: Module

  87. var pathParent: Module

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

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

  90. val printfs: ArrayBuffer[Printf]

  91. val regs: ArrayBuffer[Reg]

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

  93. def removeTypeNodes(): Int

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

  94. def reset: Bool

  95. def reset_=(): Unit

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

  97. val resets: HashMap[Bool, Bool]

  98. val signals: ArrayBuffer[Node]

  99. def stripComponent(s: String): String

  100. val switchKeys: Stack[Bits]

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

    Definition Classes
    AnyRef
  102. def toString(): String

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

  104. def traceableNodes: Array[Node]

  105. var traversal: Int

  106. def verifyAllMuxes: Unit

  107. var verilog_parameters: String

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

  109. final def wait(): Unit

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

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

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

  113. val whenConds: Stack[Bool]

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped