Add Clash.Annotations.SynthesisAttributes.markDebug (plus an unfortunate amount of baggage)
#2547
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
christiaanb
approved these changes
Jul 17, 2023
Before:
block
...
attribute str_attr of my_signal : signal is "foo";begin
...
end block;
After:
block
...
attribute str_attr of my_signal : signal is "foo";
begin
...
end block;
The former is not a VHDL attribute type
* Use TemplateHaskellQuotes where possible * Use more sensible argument names + add comment * Use string interpolation
Allows `clash-prelude` and `clash-lib` to share the type, as well as allow `Attr` to be used in combination with `TermLiteral`.
martijnbastiaan
force-pushed
the
add-mark-debug
branch
2 times, most recently
from
eab26a5
to
793f6a6
Compare
Add a term-level way of adding annotations to signals. This is more reliable than type level annotations, as it is guaranteed to survive optimizations and type alias erasure.
Add a term level way of marking a signal as "debug". This instructs synthesizers to leave a signal alone, even after optimizations.
martijnbastiaan
force-pushed
the
add-mark-debug
branch
from
793f6a6
to
9257f74
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.
I was playing around with constraint files and thought it would be nice if we could have a term level way of annotating signals with synthesis attributes. That is, the
markDebugproposed in this PR. Unfortunately, I ran into quite a number of things I needed (and "needed") to fix before being able to add the function:shouldwork/that weren't part ofclash-testsuiteboolattribute, while onlybooleanis recognizedTermLiteral (Vec n a)coreToAttrs/coreToAttr. The old implementation tried to be helpful with its error messages, but I didn't feel they helped out very much. Reading the code wasn't as nice as it could be either so...Attrto work overSymbol(type level) andString(term level)annotateAttr'now thatAttris generalizedannotate: a way of adding synthesis attributes to signalsmarkDebug: a convenience function that emits all keep/debug pragmas needed for synthesis tooling (currently verified for Vivado and Quartus)Each of these points correspond to a commit. This PR can be split up into multiple smaller ones if desired.
Still TODO: