[FIRRTL] Add YAML output to Grand Central #2045
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seldridge
force-pushed
the
dev/seldridge/gct-interfaces-yaml
branch
from
6f66983
to
8cb62d8
Compare
seldridge
force-pushed
the
dev/seldridge/gct-interfaces-yaml
branch
from
8cb62d8
to
f88768d
Compare
fabianschuiki
approved these changes
Oct 28, 2021
Comment on lines
+118
to
+122
| /// Conversion from a `DescribedSignal` to YAML. This is | ||
| /// implemented using YAML normalization to first convert this to an internal | ||
| /// `Field` structure which has a one-to-one mapping to the YAML represntation. | ||
| template <> | ||
| struct MappingContextTraits<DescribedSignal, Context> { |
There was a problem hiding this comment.
Wow this really is the most unintuitive YAML library I've seen so far 😢
There was a problem hiding this comment.
It took me a while to figure out. As I've mentioned, it appears to be ad-hoc polymorphic with some type classes that you have to implement or you get a compiler error. I didn't think this pattern was reasonable to do in C++. 🤯
Comment on lines
+916
to
+930
| if (anno.isClass("sifive.enterprise.grandcentral." | ||
| "GrandCentralHierarchyFileAnnotation")) { | ||
| if (maybeHierarchyFileYAML.hasValue()) { | ||
| emitCircuitError("more than one 'GrandCentralHierarchyFileAnnotation' " | ||
| "was found, but zero or one may be provided"); | ||
| removalError = true; | ||
| return false; | ||
| } |
There was a problem hiding this comment.
This sounds like something @darthscsi will eventually want to have as a firtool CLI argument rather than an annotation 😁. But good to have it here so we are compatible with the Scala implementation.
Comment on lines
+196
to
+252
| ; YAML: FILE "Wire/firrtl/gct/gct.yaml" | ||
| ; YAML: - name: MyInterface | ||
| ; YAML-NEXT: fields: | ||
| ; YAML-NEXT: - name: uint | ||
| ; YAML-NEXT: description: 'a wire called ''uint''' | ||
| ; YAML-NEXT: dimensions: [ ] | ||
| ; YAML-NEXT: width: 1 |
There was a problem hiding this comment.
This all looks very nice!
seldridge
force-pushed
the
dev/seldridge/gct-interfaces-yaml
branch
from
f88768d
to
d304914
Compare
Add support to the Grand Central Views/Interface pass to generate a YAML description of all interfaces created based on the presence of a GrandCentralHierarchyFileAnnotation. Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
seldridge
force-pushed
the
dev/seldridge/gct-interfaces-yaml
branch
from
d304914
to
46b8d7a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support to the Grand Central Views/Interface pass to generate a YAML
description of all interfaces created based on the presence of a
GrandCentralHierarchyFileAnnotation.
This is doing the following things:
sv::InterfaceOpto a YAML representation.