Class/Object

chisel3

Mem

Related Docs: object Mem | package chisel3

Permalink

sealed class Mem[T <: Data] extends MemBase[T]

A combinational/asynchronous-read, sequential/synchronous-write memory.

Writes take effect on the rising clock edge after the request. Reads are combinational (requests will return data on the same cycle). Read-after-write hazards are not an issue.

Note

when multiple conflicting writes are performed on a Mem element, the result is undefined (unlike Vec, where the last assignment wins)

Linear Supertypes
MemBase[T], SourceInfoDoc, NamedComponent, HasId, internal.InstanceId, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mem
  2. MemBase
  3. SourceInfoDoc
  4. NamedComponent
  5. HasId
  6. InstanceId
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. macro def apply(x: UInt): T

    Permalink

    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.

    Definition Classes
    MemBase
  5. macro def apply(x: Int): T

    Permalink

    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.

    Definition Classes
    MemBase
  6. macro def apply(x: BigInt): T

    Permalink

    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.

    Definition Classes
    MemBase
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def circuitName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasId
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def computeName(defaultPrefix: Option[String], defaultSeed: Option[String]): Option[String]

    Permalink

    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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

    Definition Classes
    MemBase
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hasSeed: Boolean

    Permalink

    returns

    Whether either autoName or suggestName has been called

    Definition Classes
    HasId
  20. def hashCode(): Int

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  21. def instanceName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val length: BigInt

    Permalink
    Definition Classes
    MemBase
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def parentModName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  28. def parentPathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  29. def pathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  30. macro def read(x: UInt): T

    Permalink

    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.

    Definition Classes
    MemBase
  31. def suggestName(seed: ⇒ String): Mem.this.type

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  33. val t: T

    Permalink
    Definition Classes
    MemBase
  34. final def toAbsoluteTarget: ReferenceTarget

    Permalink

    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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def toTarget: ReferenceTarget

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def write(idx: UInt, data: T, mask: Seq[Bool])(implicit evidence: <:<[T, Vec[_]], compileOptions: CompileOptions): Unit

    Permalink

    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.

    Definition Classes
    MemBase
    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

    Permalink

    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

    Definition Classes
    MemBase

Inherited from MemBase[T]

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

SourceInfoTransformMacro

Ungrouped