Packages

p

firrtl

annotations

package annotations

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. trait Annotation extends AnyRef

    Base type of auxiliary information

  2. case class AnnotationClassNotFoundException(className: String) extends FIRRTLException with Product with Serializable
  3. case class AnnotationException(message: String) extends Exception with Product with Serializable
  4. case class AnnotationFileNotFoundException(file: File) extends FIRRTLException with Product with Serializable
  5. final case class CircuitName(name: String) extends Named with Product with Serializable
  6. final case class ComponentName(name: String, module: ModuleName) extends Named with Product with Serializable
  7. case class DeletedAnnotation(xFormName: String, anno: Annotation) extends NoTargetAnnotation with Product with Serializable
  8. case class InvalidAnnotationFileException(file: File, cause: Throwable = null) extends FIRRTLException with Product with Serializable
  9. case class InvalidAnnotationJSONException(msg: String) extends FIRRTLException with Product with Serializable
  10. final case class LegacyAnnotation extends SingleTargetAnnotation[Named] with Product with Serializable
  11. case class LoadMemoryAnnotation(target: ComponentName, fileName: String, hexOrBinary: FileType = MemoryLoadFileType.Hex, originalMemoryNameOpt: Option[String] = None) extends SingleTargetAnnotation[Named] with Product with Serializable

    Firrtl implementation for load memory

    Firrtl implementation for load memory

    target

    memory to load

    fileName

    name of input file

    hexOrBinary

    use $readmemh or $readmemb

  12. final case class ModuleName(name: String, circuit: CircuitName) extends Named with Product with Serializable
  13. sealed trait Named extends AnyRef

    Named classes associate an annotation with a component in a Firrtl circuit

  14. trait NoTargetAnnotation extends Annotation

    If an Annotation does not target any Named thing in the circuit, then all updates just return the Annotation itself

  15. trait SingleTargetAnnotation[T <: Named] extends Annotation

    An Annotation that targets a single Named thing

  16. trait SingleStringAnnotation extends NoTargetAnnotation
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Just extend NoTargetAnnotation

Value Members

  1. object Annotation
  2. object AnnotationUtils
  3. object AnnotationYamlProtocol extends DefaultYamlProtocol
  4. object JsonProtocol
  5. object MemoryLoadFileType extends Enumeration

    Enumeration of the two types of readmem statements available in verilog

Ungrouped