chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package annotations
  Definition Classes
    firrtl
- Annotation
- AnnotationClassNotFoundException
- AnnotationException
- AnnotationFileNotFoundException
- AnnotationUtils
- CircuitName
- CircuitTarget
- CompleteTarget
- ComponentName
- GenericTarget
- HasSerializationHints
- InstanceTarget
- InvalidAnnotationFileException
- InvalidAnnotationJSONException
- IsComponent
- IsMember
- IsModule
- JsonProtocol
- LoadMemoryAnnotation
- MemoryFileInlineAnnotation
- MemoryInitAnnotation
- MemoryLoadFileType
- ModuleName
- ModuleTarget
- Named
- NoTargetAnnotation
- ReferenceTarget
- SingleTargetAnnotation
- Target
- TargetToken
- UnrecogizedAnnotationsException
- UnrecognizedAnnotation
- UnserializableAnnotationException
- UnserializeableAnnotation

c

firrtl.annotations

# LoadMemoryAnnotation

###

#### case class LoadMemoryAnnotation(target: ComponentName, fileName: String, hexOrBinary: MemoryLoadFileType = MemoryLoadFileType.Hex, originalMemoryNameOpt: Option[String] = None) extends SingleTargetAnnotation[Named] with Product with Serializable

Firrtl implementation for load memory

target

  memory to load

fileName

  name of input file

hexOrBinary

  use `$readmemh` or `$readmemb`

Source
  LoadMemoryAnnotation.scala

Linear Supertypes
Serializable, SingleTargetAnnotation[Named], Annotation, Product, Equals, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. LoadMemoryAnnotation
2. Serializable
3. SingleTargetAnnotation
4. Annotation
5. Product
6. Equals
7. AnyRef
8. 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

### Instance Constructors

1.  new LoadMemoryAnnotation(target: ComponentName, fileName: String, hexOrBinary: MemoryLoadFileType = MemoryLoadFileType.Hex, originalMemoryNameOpt: Option[String] = None)

   target

     memory to load

   fileName

     name of input file

   hexOrBinary

     use `$readmemh` or `$readmemb`

### 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 LoadMemoryAnnotation toany2stringadd[LoadMemoryAnnotation] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (LoadMemoryAnnotation, B)
   Implicit
     This member is added by an implicit conversion from LoadMemoryAnnotation toArrowAssoc[LoadMemoryAnnotation] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def duplicate(newNamed: Named): LoadMemoryAnnotation

   Create another instance of this Annotation

   Create another instance of this Annotation

   Definition Classes
     LoadMemoryAnnotation → SingleTargetAnnotation
9.  def ensuring(cond: (LoadMemoryAnnotation) => Boolean, msg: => Any): LoadMemoryAnnotation
   Implicit
     This member is added by an implicit conversion from LoadMemoryAnnotation toEnsuring[LoadMemoryAnnotation] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (LoadMemoryAnnotation) => Boolean): LoadMemoryAnnotation
    Implicit
      This member is added by an implicit conversion from LoadMemoryAnnotation toEnsuring[LoadMemoryAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): LoadMemoryAnnotation
    Implicit
      This member is added by an implicit conversion from LoadMemoryAnnotation toEnsuring[LoadMemoryAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): LoadMemoryAnnotation
    Implicit
      This member is added by an implicit conversion from LoadMemoryAnnotation toEnsuring[LoadMemoryAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  val fileName: String
15.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
16.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def getFileName: String
18.  def getPrefix: String
19.  def getSuffix: String
20.  val hexOrBinary: MemoryLoadFileType
21.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  val originalMemoryNameOpt: Option[String]
26.  val prefix: String
27.  def productElementNames: Iterator[String]
    Definition Classes
      Product
28.  def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
      Annotation
    Note

      rarely used

29.  val suffix: String
30.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
31.  val target: ComponentName
    Definition Classes
      LoadMemoryAnnotation → SingleTargetAnnotation
32.  def update(renames: RenameMap): Seq[Annotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
      SingleTargetAnnotation → Annotation
33.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
34.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
35.  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 LoadMemoryAnnotation toStringFormat[LoadMemoryAnnotation] 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): (LoadMemoryAnnotation, B)
   Implicit
     This member is added by an implicit conversion from LoadMemoryAnnotation toArrowAssoc[LoadMemoryAnnotation] 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 Serializable

### Inherited from SingleTargetAnnotation[Named]

### Inherited from Annotation

### Inherited from Product

### Inherited from Equals

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromLoadMemoryAnnotation to any2stringadd[LoadMemoryAnnotation]

### Inherited by implicit conversion StringFormat fromLoadMemoryAnnotation to StringFormat[LoadMemoryAnnotation]

### Inherited by implicit conversion Ensuring fromLoadMemoryAnnotation to Ensuring[LoadMemoryAnnotation]

### Inherited by implicit conversion ArrowAssoc fromLoadMemoryAnnotation to ArrowAssoc[LoadMemoryAnnotation]

### Ungrouped