firrtl.backends.proto.Annotation
ProtoBufSerialization
Related Doc:
package Annotation
Output filename where serialized content will be written
Output filename where serialized content will be written
The full annotation sequence is a parameter to allow for the location where this annotation will be serialized to be a function of other annotations, e.g., if the location where information is written is controlled by a separate file location annotation.
the annotation sequence at the time of emission
Method that returns the filename where this annotation will be serialized.
Method that returns the filename where this annotation will be serialized.
the annotations at the time of serialization
A method that can convert this annotation to bytes that will be written to a file.
A method that can convert this annotation to bytes that will be written to a file.
If you only need to serialize a string, you can use the getBytes method:
def getBytes: Iterable[Byte] = myString.getBytes
Returns all Target members in this annotation
Returns all Target members in this annotation
The hash code is cached for this case class because it includes a very large circuit operand whose hash is expensive to compute.
The hash code is cached for this case class because it includes a very large circuit operand whose hash is expensive to compute. This is safe to do because the case class is immutable.
Optionally, a sequence of annotations that will replace this annotation in the output annotation file.
Optionally, a sequence of annotations that will replace this annotation in the output annotation file.
A non-empty implementation of this method is a mechanism for telling a downstream Stage how to deserialize the information that was serialized to a separate file. For example, if a FIRRTL circuit is serialized to a separate file, this method could include an input file annotation that a later stage can use to read the serialized FIRRTL circuit back in.
Optional pretty print
Optional pretty print
rarely used
Optional suffix of the output file
Optional suffix of the output file
Update the target based on how signals are renamed
Update the target based on how signals are renamed
This will cause the enclosed circuit to be serialized to a Protocol Buffer with the provided suffix.