docs: Add documentation for partially assigned register design error #283
Conversation
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
Dolu1990
reviewed
Dec 4, 2025
| Introduction | ||
| ------------ | ||
|
|
||
| SpinalHDL will check that when a register is conditionally assigned, all bits of the register must be assigned in every execution path. If some bits of a register are left unassigned in certain conditions, it can lead to unintended hardware behavior such as latches or unpredictable values. |
Member
There was a problem hiding this comment.
all bits of the register must be assigned in every execution path
I think it can be confusing, as some could understand it as :
when X
need to assign all bits of reg
else
need to assign all bits of reg
Instead maybe it can be :
"all bits of the register must at least be assigned once" ?
Contributor
Author
There was a problem hiding this comment.
Thank you for the feedback! I agree the original wording is ambigous.
Contributor
Author
There was a problem hiding this comment.
Updated! Changed to "all bits of the register must at least be assigned once" as suggested.
jooyeon111
force-pushed
the
docs/partially-assigned-register
branch
from
071e362 to
de96364
Compare
Member
|
Thanks ^^ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 documentation for "Partially assigned register" design error.
Fixes #127