chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/chisel3/Module

Module

chisel3.Module
See theModule companion class
object Module

Attributes

Companion
class
Source
Module.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Module.type

Members list

Type members

Classlikes

object ResetType

Allowed values for the types of Module.reset

Allowed values for the types of Module.reset

Attributes

Source
Module.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ResetType.type

Value members

Concrete methods

def clock: Clock

Returns the implicit Clock

Returns the implicit Clock

Attributes

Source
Module.scala
def clockOption: Option[Clock]

Returns the implicit Clock, if it is defined

Returns the implicit Clock, if it is defined

Attributes

Source
Module.scala
def currentModule: Option[BaseModule]

Returns the current Module

Returns the current Module

Attributes

Source
Module.scala
def currentModulePrefix: String

Returns the current nested module prefix

Returns the current nested module prefix

Attributes

Source
Module.scala
def disable(implicit sourceInfo: SourceInfo): Disable

Returns the implicit Disable

Returns the implicit Disable

Note that Disable is a function of the implicit clock and reset so having no implicit clock or reset may imply no Disable.

Attributes

Source
Module.scala
def disableOption(implicit sourceInfo: SourceInfo): Option[Disable]

Returns the current implicit Disable, if one is defined

Returns the current implicit Disable, if one is defined

Note that Disable is a function of the implicit clock and reset so having no implicit clock or reset may imply no Disable.

Attributes

Source
Module.scala
def reset: Reset

Returns the implicit Reset

Returns the implicit Reset

Attributes

Source
Module.scala
def resetOption: Option[Reset]

Returns the implicit Reset, if it is defined

Returns the implicit Reset, if it is defined

Attributes

Source
Module.scala

Inherited methods

def apply[T <: BaseModule](bc: => T)(using SourceInfo): T

A wrapper method that all Module instantiations must be wrapped in (necessary to help Chisel track internal state).

A wrapper method that all Module instantiations must be wrapped in (necessary to help Chisel track internal state).

Value parameters

bc

the Module being created

Attributes

Returns

the input module m with Chisel metadata properly set

Inherited from:
Module$Intf (hidden)
Source
ModuleIntf.scala
Generated with