Change ClockDomain fields, period -> synchronousTo#5237
Merged
Conversation
Change the schema for clock domains. Previously, this included an integer "period" representing the period of this clock. This, however, is not something that is really important _in Chisel_. Instead, add a new string "synchronousTo" field which is used to track what clock domain a new clock domain is derived from / synchronous to. This is technically not Chisel API breaking in any way, but may break downstream users relying on this. Note: domains are completely in flux at this point and being jointly developed with CIRCT. Hence, this is fine to break and may break more in the future. AI-assisted-by: Augment (Claude Sonnet 4.5) Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Contributor
|
As this API change only affects the version of domain tool one is using (and that's not something we've really rolled out yet), I'm okay with treating this as non-major version bumping. |
jackkoenig
approved these changes
Mar 19, 2026
This file contains hidden or 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
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.
Change the schema for clock domains. Previously, this included an integer
"period" representing the period of this clock. This, however, is not
something that is really important in Chisel. Instead, add a new string
"synchronousTo" field which is used to track what clock domain a new clock
domain is derived from / synchronous to.
This is technically not Chisel API breaking in any way, but may break
downstream users relying on this. Note: domains are completely in flux at
this point and being jointly developed with CIRCT. Hence, this is fine to
break and may break more in the future.
AI-assisted-by: Augment (Claude Sonnet 4.5)
Release Notes
Change ClockDomain schema: remove
period, andsynchronousTo.