Package

firrtl

annotations

Permalink

package annotations

Content Hierarchy
Visibility
  1. Public
  2. All

Type Members

  1. trait Annotation extends AnyRef

    Permalink

    Base type of auxiliary information

  2. case class AnnotationClassNotFoundException(className: String) extends FIRRTLException with Product with Serializable

    Permalink
  3. case class AnnotationException(message: String) extends Exception with Product with Serializable

    Permalink
  4. case class AnnotationFileNotFoundException(file: File) extends FIRRTLException with Product with Serializable

    Permalink
  5. final case class CircuitName(name: String) extends Named with Product with Serializable

    Permalink
  6. final case class ComponentName(name: String, module: ModuleName) extends Named with Product with Serializable

    Permalink
  7. case class DeletedAnnotation(xFormName: String, anno: Annotation) extends NoTargetAnnotation with Product with Serializable

    Permalink
  8. case class InvalidAnnotationFileException(file: File, cause: Throwable = null) extends FIRRTLException with Product with Serializable

    Permalink
  9. case class InvalidAnnotationJSONException(msg: String) extends FIRRTLException with Product with Serializable

    Permalink
  10. final case class LegacyAnnotation extends SingleTargetAnnotation[Named] with Product with Serializable

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

    Permalink

    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

    Permalink
  13. sealed trait Named extends AnyRef

    Permalink

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

  14. trait NoTargetAnnotation extends Annotation

    Permalink

    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

    Permalink

    An Annotation that targets a single Named thing

  16. trait SingleStringAnnotation extends NoTargetAnnotation

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Just extend NoTargetAnnotation

Value Members

  1. object Annotation

    Permalink
  2. object AnnotationUtils

    Permalink
  3. object AnnotationYamlProtocol extends DefaultYamlProtocol

    Permalink
  4. object JsonProtocol

    Permalink
  5. object MemoryLoadFileType extends Enumeration

    Permalink

    Enumeration of the two types of readmem statements available in verilog

Ungrouped