Packages

c

chisel3

MemBase

sealed abstract class MemBase[T <: Data] extends HasId with NamedComponent with SourceInfoDoc

Source
Mem.scala
Linear Supertypes
SourceInfoDoc, NamedComponent, HasId, internal.InstanceId, AnyRef, Any
Known Subclasses
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. MemBase
  2. SourceInfoDoc
  3. NamedComponent
  4. HasId
  5. InstanceId
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. macro def apply(x: UInt): T

    Creates a read/write accessor into the memory with dynamic addressing.

    Creates a read/write accessor into the memory with dynamic addressing. See the class documentation of the memory for more detailed information.

  5. macro def apply(x: Int): T

    Creates a read accessor into the memory with static addressing.

    Creates a read accessor into the memory with static addressing. See the class documentation of the memory for more detailed information.

  6. macro def apply(x: BigInt): T

    Creates a read accessor into the memory with static addressing.

    Creates a read accessor into the memory with static addressing. See the class documentation of the memory for more detailed information.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def computeName(defaultPrefix: Option[String], defaultSeed: Option[String]): Option[String]

    Computes the name of this HasId, if one exists

    Computes the name of this HasId, if one exists

    defaultPrefix

    Optionally provide a default prefix for computing the name

    defaultSeed

    Optionally provide default seed for computing the name

    returns

    the name, if it can be computed

    Definition Classes
    HasId
  11. def do_apply(idx: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

  12. def do_apply(idx: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

  13. def do_apply(idx: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

  14. def do_read(idx: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hasSeed: Boolean

    returns

    Whether either autoName or suggestName has been called

    Definition Classes
    HasId
  20. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  21. def instanceName: String
    Definition Classes
    HasId → InstanceId
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val length: BigInt
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def parentModName: String
    Definition Classes
    HasId → InstanceId
  28. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  29. def pathName: String
    Definition Classes
    HasId → InstanceId
  30. macro def read(x: UInt): T

    Creates a read accessor into the memory with dynamic addressing.

    Creates a read accessor into the memory with dynamic addressing. See the class documentation of the memory for more detailed information.

  31. def suggestName(seed: ⇒ String): MemBase.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
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. val t: T
  34. final def toAbsoluteTarget: ReferenceTarget

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Definition Classes
    NamedComponent → InstanceId
  35. final def toNamed: ComponentName

    Returns a FIRRTL ComponentName that references this object

    Returns a FIRRTL ComponentName that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def toTarget: ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object

    Returns a FIRRTL ReferenceTarget that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. def write(idx: UInt, data: T, mask: Seq[Bool])(implicit evidence: <:<[T, Vec[_]], compileOptions: CompileOptions): Unit

    Creates a masked write accessor into the memory.

    Creates a masked write accessor into the memory.

    idx

    memory element index to write into

    data

    new data to write

    mask

    write mask as a Seq of Bool: a write to the Vec element in memory is only performed if the corresponding mask index is true.

    Note

    this is only allowed if the memory's element data type is a Vec

  42. def write(idx: UInt, data: T)(implicit compileOptions: CompileOptions): Unit

    Creates a write accessor into the memory.

    Creates a write accessor into the memory.

    idx

    memory element index to write into

    data

    new data to write

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped

SourceInfoTransformMacro

These internal methods are not part of the public-facing API!

The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a Seq of Bools look at the asBools above, not the one below. Users can safely ignore every method in this group!

🐉🐉🐉 Here be dragons... 🐉🐉🐉

These do_X methods are used to enable both implicit passing of SourceInfo and chisel3.CompileOptions while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.

The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an implicitly[SourceInfo] as the explicit argument.