Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    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 util
    Definition Classes
    experimental
  • SerializableModuleElaborator
t

chisel3.experimental.util

SerializableModuleElaborator

trait SerializableModuleElaborator extends AnyRef

Mixin this trait to produce elaborators for SerializableModule

Source
SerializableModuleElaborator.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SerializableModuleElaborator
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 SerializableModuleElaborator toany2stringadd[SerializableModuleElaborator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SerializableModuleElaborator, B)
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toArrowAssoc[SerializableModuleElaborator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def additionalAnnotations: Seq[Annotation]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def configImpl[P <: SerializableModuleParameter](parameter: P)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[P], rwP: upickle.default.Writer[P]): Readable

    Implementation of a config API to serialize the SerializableModuleParameter

    Implementation of a config API to serialize the SerializableModuleParameter

    Example:

    1. def config(parameter: MySerializableModuleParameter) =
  os.write.over(os.pwd / "config.json", configImpl(parameter))
  10. def designImpl[M <: SerializableModule[P], P <: SerializableModuleParameter](parameter: Readable)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[M], arg1: scala.reflect.api.JavaUniverse.TypeTag[P], rwP: upickle.default.Reader[P]): (Readable, Readable)

    Implementation of a design API to elaborate SerializableModule

    Implementation of a design API to elaborate SerializableModule

    returns

    A tuple of Readable, where the first is the firrtl and the second is the serializable annotations

    Example:

    1. def design(parameter: os.Path) = {
  val (firrtl, annos) = designImpl[MySerializableModule, MySerializableModuleParameter](os.read.stream(parameter))
  os.write.over(os.pwd / "GCD.fir", firrtl)
  os.write.over(os.pwd / "GCD.anno.json", annos)
}
  11. def ensuring(cond: (SerializableModuleElaborator) => Boolean, msg: => Any): SerializableModuleElaborator
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toEnsuring[SerializableModuleElaborator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (SerializableModuleElaborator) => Boolean): SerializableModuleElaborator
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toEnsuring[SerializableModuleElaborator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): SerializableModuleElaborator
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toEnsuring[SerializableModuleElaborator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): SerializableModuleElaborator
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toEnsuring[SerializableModuleElaborator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toStringFormat[SerializableModuleElaborator] 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): (SerializableModuleElaborator, B)
    Implicit
    This member is added by an implicit conversion from SerializableModuleElaborator toArrowAssoc[SerializableModuleElaborator] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSerializableModuleElaborator to any2stringadd[SerializableModuleElaborator]

Inherited by implicit conversion StringFormat fromSerializableModuleElaborator to StringFormat[SerializableModuleElaborator]

Inherited by implicit conversion Ensuring fromSerializableModuleElaborator to Ensuring[SerializableModuleElaborator]

Inherited by implicit conversion ArrowAssoc fromSerializableModuleElaborator to ArrowAssoc[SerializableModuleElaborator]

Ungrouped