sealed abstract class MemBase[T <: Data] extends HasId with NamedComponent with SourceInfoDoc
- Grouped
- Alphabetic
- By Inheritance
- MemBase
- SourceInfoDoc
- NamedComponent
- HasId
- InstanceId
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (MemBase[T], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- macro def apply(x: UInt, y: Clock): T
- 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.
- 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.
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def circuitName: String
- Definition Classes
- HasId
- def clockWarning(sourceInfo: Option[SourceInfo], dir: MemPortDirection): Unit
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def do_apply(idx: UInt, clock: Clock)(implicit sourceInfo: SourceInfo): T
- def do_apply(idx: UInt)(implicit sourceInfo: SourceInfo): T
- def do_apply(idx: Int)(implicit sourceInfo: SourceInfo): T
- def do_apply(idx: BigInt)(implicit sourceInfo: SourceInfo): T
- def do_apply_impl(idx: UInt, clock: Clock, dir: MemPortDirection, warn: Boolean)(implicit sourceInfo: SourceInfo): T
- Attributes
- protected
- def do_read(idx: UInt, clock: Clock)(implicit sourceInfo: SourceInfo): T
- def do_read(idx: UInt)(implicit sourceInfo: SourceInfo): T
- def do_write(idx: UInt, data: T, mask: Seq[Bool], clock: Clock)(implicit evidence: <:<[T, Vec[_]], sourceInfo: SourceInfo): Unit
- def do_write(idx: UInt, data: T, mask: Seq[Bool])(implicit evidence: <:<[T, Vec[_]], sourceInfo: SourceInfo): Unit
- def do_write(idx: UInt, data: T, clock: Clock)(implicit sourceInfo: SourceInfo): Unit
- def do_write(idx: UInt, data: T)(implicit sourceInfo: SourceInfo): Unit
- def ensuring(cond: (MemBase[T]) => Boolean, msg: => Any): MemBase[T]
- def ensuring(cond: (MemBase[T]) => Boolean): MemBase[T]
- def ensuring(cond: Boolean, msg: => Any): MemBase[T]
- def ensuring(cond: Boolean): MemBase[T]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- HasId → AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasSeed: Boolean
- returns
Whether either autoName or suggestName has been called
- Definition Classes
- HasId
- def hashCode(): Int
- Definition Classes
- HasId → AnyRef → Any
- def instanceName: String
- Definition Classes
- HasId → InstanceId
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val length: BigInt
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parentModName: String
- Definition Classes
- HasId → InstanceId
- def parentPathName: String
- Definition Classes
- HasId → InstanceId
- def pathName: String
- Definition Classes
- HasId → InstanceId
- macro def read(x: UInt, y: Clock): T
Creates a read accessor into the memory with dynamic addressing.
Creates a read accessor into the memory with dynamic addressing. Takes a clock parameter to bind a clock that may be different from the implicit clock. See the class documentation of the memory for more detailed information.
- 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.
- 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 whetherautoSeedwas called, suggestName will always take precedence.- seed
The seed for the name of this component
- returns
this object
- Definition Classes
- HasId
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val t: T
- 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
- 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
- final def toRelativeTarget(root: Option[BaseModule]): ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
If
rootis defined, the target is a hierarchical path starting fromroot.If
rootis not defined, the target is a hierarchical path equivalent totoAbsoluteTarget.- Definition Classes
- NamedComponent
- Note
If
,rootis defined, and has not finished elaboration, this must be called withinatModuleBodyEnd.The NamedComponent must be a descendant of
,root, if it is defined.This doesn't have special handling for Views.
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- macro def write(idx: UInt, writeData: T, mask: Seq[Bool], clock: Clock)(implicit evidence: <:<[T, Vec[_]]): Unit
Creates a masked write accessor into the memory with a clock that may be different from the implicit clock.
Creates a masked write accessor into the memory with a clock that may be different from the implicit clock.
- idx
memory element index to write into
- 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.
- clock
clock to bind to this accessor
- Note
this is only allowed if the memory's element data type is a Vec
- macro def write(idx: UInt, writeData: T, mask: Seq[Bool])(implicit evidence: <:<[T, Vec[_]]): Unit
Creates a masked write accessor into the memory.
Creates a masked write accessor into the memory.
- idx
memory element index to write into
- 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
- macro def write(idx: UInt, data: T, clock: Clock): Unit
Creates a write accessor into the memory with a clock that may be different from the implicit clock.
Creates a write accessor into the memory with a clock that may be different from the implicit clock.
- idx
memory element index to write into
- data
new data to write
- clock
clock to bind to this accessor
- macro def write(idx: UInt, data: T): 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
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MemBase[T] toStringFormat[MemBase[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (MemBase[T], B)
- Implicit
- This member is added by an implicit conversion from MemBase[T] toArrowAssoc[MemBase[T]] 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 SourceInfoDoc
Inherited from NamedComponent
Inherited from HasId
Inherited from 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
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.