Skip to content

Change ClockDomain fields, period -> synchronousTo#5237

Merged
seldridge merged 1 commit into
mainfrom
domain-clockdomain-fields
Mar 19, 2026
Merged

Change ClockDomain fields, period -> synchronousTo#5237
seldridge merged 1 commit into
mainfrom
domain-clockdomain-fields

Conversation

@seldridge

Copy link
Copy Markdown
Member

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, and synchronousTo.

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>
@seldridge seldridge enabled auto-merge (squash) March 19, 2026 05:05
@seldridge seldridge requested a review from jackkoenig March 19, 2026 05:05
@jackkoenig

Copy link
Copy Markdown
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.

@seldridge seldridge merged commit 260674b into main Mar 19, 2026
30 checks passed
@seldridge seldridge deleted the domain-clockdomain-fields branch March 19, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants