chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package dataview
  Definition Classes
    experimental
-  package hierarchy
  Definition Classes
    experimental
- AffectsChiselPrefix
- Analog
- BaseModule
- BundleLiteralException
- BundleLiterals
- ChiselAnnotation
- ChiselMultiAnnotation
- ChiselSubtypeOf
- CloneModuleAsRecord
- DeprecatedSourceInfo
- DoubleParam
- EnumAnnotations
- ExtModule
- HWTuple10
- HWTuple2
- HWTuple3
- HWTuple4
- HWTuple5
- HWTuple6
- HWTuple7
- HWTuple8
- HWTuple9
- HasAutoTypename
- HasTypeAlias
- IntParam
- IntrinsicModule
- NoSourceInfo
- OpaqueType
- Param
- RawParam
- RecordAlias
- SerializableModule
- SerializableModuleGenerator
- SerializableModuleParameter
- SourceInfo
- SourceLine
- StringParam
- Trace
- UnlocatableSourceInfo
- VecLiteralException
- VecLiterals
- annotate
- attach
- dedupGroup
- doNotDedup
- dump
- noPrefix
- prefix
- requireIsAnnotatable
- requireIsChiselType
- requireIsHardware
- skipPrefix
- treedump

c

chisel3.experimental

# IntrinsicModule

###

#### abstract class IntrinsicModule extends BaseIntrinsicModule

Source
  IntrinsicModule.scala

Linear Supertypes
BaseIntrinsicModule, BaseModule, IsInstantiable, HasId, InstanceId, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. IntrinsicModule
2. BaseIntrinsicModule
3. BaseModule
4. IsInstantiable
5. HasId
6. InstanceId
7. AnyRef
8. Any

Implicitly

1. by BaseModuleExtensions
2. by IsInstantiableExtensions
3. by any2stringadd
4. by StringFormat
5. by Ensuring
6. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new IntrinsicModule(intrinsicName: String, params: Map[String, Param] = Map.empty[String, Param])

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toany2stringadd[IntrinsicModule] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (IntrinsicModule, B)
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toArrowAssoc[IntrinsicModule] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def IO[T <: Data](iodef: => T)(implicit sourceInfo: SourceInfo): T

   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 must be a chisel type and not be bound to hardware.

   Also registers an 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
7.  def _bindIoInPlace(iodef: Data)(implicit sourceInfo: SourceInfo): Unit

   Chisel2 code didn't require the IO(...) wrapper and would assign a Chisel type directly to io, then do operations on it.

   Chisel2 code didn't require the IO(...) wrapper and would assign a Chisel type directly to io, then do operations on it. This binds a Chisel type in-place (mutably) as an IO.

   Attributes
     protected
   Definition Classes
     BaseModule
8.  var _closed: Boolean
   Attributes
     protected
   Definition Classes
     BaseModule
9.  def _moduleDefinitionIdentifierProposal: String
   Attributes
     protected
   Definition Classes
     BaseModule
10.  def _sourceInfo: SourceInfo
    Attributes
      protected
    Definition Classes
      BaseModule
11.  def _traitModuleDefinitionIdentifierProposal: Option[String]
    Attributes
      protected
    Definition Classes
      BaseModule
12.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
13.  def circuitName: String
    Definition Classes
      HasId
14.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
15.  final val definitionIdentifier: String

    Represents an eagerly-determined unique and descriptive identifier for this module

    Represents an eagerly-determined unique and descriptive identifier for this module

    Definition Classes
      BaseModule
16.  def desiredName: String

    The desired name of this module (which will be used in generated FIRRTL IR or Verilog).

    The desired name of this module (which will be used in generated FIRRTL IR or Verilog).

    The name of a module approximates the behavior of the Java Reflection `getSimpleName` method https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#getSimpleName-- with some modifications:

    - Anonymous modules will get an `"_Anon"` tag - Modules defined in functions will use their class name and not a numeric name

    Definition Classes
      BaseModule
    Note

      If you want a custom or parametric name, override this method.

17.  def endIOCreation()(implicit si: SourceInfo): Unit

    Disallow any more IO creation for this module.

    Disallow any more IO creation for this module.

    Definition Classes
      BaseModule
18.  def ensuring(cond: (IntrinsicModule) => Boolean, msg: => Any): IntrinsicModule
    Implicit
      This member is added by an implicit conversion from IntrinsicModule toEnsuring[IntrinsicModule] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
19.  def ensuring(cond: (IntrinsicModule) => Boolean): IntrinsicModule
    Implicit
      This member is added by an implicit conversion from IntrinsicModule toEnsuring[IntrinsicModule] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
20.  def ensuring(cond: Boolean, msg: => Any): IntrinsicModule
    Implicit
      This member is added by an implicit conversion from IntrinsicModule toEnsuring[IntrinsicModule] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
21.  def ensuring(cond: Boolean): IntrinsicModule
    Implicit
      This member is added by an implicit conversion from IntrinsicModule toEnsuring[IntrinsicModule] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
22.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  def equals(that: Any): Boolean
    Definition Classes
      HasId → AnyRef → Any
24.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
25.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
26.  def getModulePorts: Seq[Data]
    Attributes
      protected[chisel3]
    Definition Classes
      BaseModule
27.  def hasSeed: Boolean

    returns

      Whether either autoName or suggestName has been called

    Definition Classes
      HasId
28.  def hashCode(): Int
    Definition Classes
      HasId → AnyRef → Any
29.  def instanceName: String

    Signal name (for simulation).

    Signal name (for simulation).

    Definition Classes
      BaseModule → HasId → InstanceId
30.  val intrinsic: String
    Definition Classes
      BaseIntrinsicModule
31.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
32.  final lazy val name: String

    Legalized name of this module.

    Legalized name of this module.

    Definition Classes
      BaseModule
33.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
34.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
35.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
36.  val params: Map[String, Param]
37.  def parentModName: String
    Definition Classes
      HasId → InstanceId
38.  def parentPathName: String
    Definition Classes
      HasId → InstanceId
39.  def pathName: String
    Definition Classes
      HasId → InstanceId
40.  def portsContains(elem: Data): Boolean
    Attributes
      protected
    Definition Classes
      BaseModule
41.  def portsSize: Int
    Attributes
      protected
    Definition Classes
      BaseModule
42.  def suggestName(seed: => String): IntrinsicModule.this.type

    Takes the first seed suggested.

    Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.

    Is a higher priority than `autoSeed`, in that regardless of whether `autoSeed` was called, suggestName will always take precedence.

    seed

      The seed for the name of this component

    returns

      this object

    Definition Classes
      HasId
43.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
44.  final def toAbsoluteTarget: IsModule

    Returns a FIRRTL ModuleTarget that references this object

    Returns a FIRRTL ModuleTarget that references this object

    Definition Classes
      BaseModule → InstanceId
    Note

      Should not be called until circuit elaboration is complete

45.  def toDefinition: Definition[IntrinsicModule]
    Implicit
      This member is added by an implicit conversion from IntrinsicModule toBaseModuleExtensions[IntrinsicModule] performed by method BaseModuleExtensions in chisel3.experimental.BaseModule.
    Definition Classes
      BaseModuleExtensions
46.  final def toNamed: ModuleName

    Returns a FIRRTL ModuleName that references this object

    Returns a FIRRTL ModuleName that references this object

    Definition Classes
      BaseModule → InstanceId
    Note

      Should not be called until circuit elaboration is complete

47.  final def toRelativeTarget(root: Option[BaseModule]): IsModule

    Returns a FIRRTL ModuleTarget that references this object, relative to an optional root.

    Returns a FIRRTL ModuleTarget that references this object, relative to an optional root.

    If `root` is defined, the target is a hierarchical path starting from `root`.

    If `root` is not defined, the target is a hierarchical path equivalent to `toAbsoluteTarget`.

    Definition Classes
      BaseModule
    Note

      If `root` is defined, and has not finished elaboration, this must be called within `atModuleBodyEnd`.

      ,

      The BaseModule must be a descendant of `root`, if it is defined.

      ,

      This doesn't have special handling for Views.

48.  def toString(): String
    Definition Classes
      AnyRef → Any
49.  final def toTarget: ModuleTarget

    Returns a FIRRTL ModuleTarget that references this object

    Returns a FIRRTL ModuleTarget that references this object

    Definition Classes
      BaseModule → InstanceId
    Note

      Should not be called until circuit elaboration is complete

50.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
51.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
52.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Shadowed Implicit Value Members

1.  def toInstance: Instance[IntrinsicModule]
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toBaseModuleExtensions[IntrinsicModule] performed by method BaseModuleExtensions in chisel3.experimental.BaseModule.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (intrinsicModule: BaseModuleExtensions[IntrinsicModule]).toInstance

   Definition Classes
     BaseModuleExtensions
2.  def toInstance: Instance[IntrinsicModule]
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toIsInstantiableExtensions[IntrinsicModule] performed by method IsInstantiableExtensions in chisel3.experimental.hierarchy.core.IsInstantiable.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (intrinsicModule: IsInstantiableExtensions[IntrinsicModule]).toInstance

   Definition Classes
     IsInstantiableExtensions

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toStringFormat[IntrinsicModule] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (IntrinsicModule, B)
   Implicit
     This member is added by an implicit conversion from IntrinsicModule toArrowAssoc[IntrinsicModule] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from BaseIntrinsicModule

### Inherited from BaseModule

### Inherited from IsInstantiable

### Inherited from HasId

### Inherited from InstanceId

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion BaseModuleExtensions fromIntrinsicModule to BaseModuleExtensions[IntrinsicModule]

### Inherited by implicit conversion IsInstantiableExtensions fromIntrinsicModule to IsInstantiableExtensions[IntrinsicModule]

### Inherited by implicit conversion any2stringadd fromIntrinsicModule to any2stringadd[IntrinsicModule]

### Inherited by implicit conversion StringFormat fromIntrinsicModule to StringFormat[IntrinsicModule]

### Inherited by implicit conversion Ensuring fromIntrinsicModule to Ensuring[IntrinsicModule]

### Inherited by implicit conversion ArrowAssoc fromIntrinsicModule to ArrowAssoc[IntrinsicModule]

### Ungrouped