Document StreamAccessibleFifo and StreamShiftChain#290
Draft
Document StreamAccessibleFifo and StreamShiftChain#290
Conversation
Co-authored-by: Readon <3614708+Readon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document StreamAccessibleFifo and StreamShiftChain
Document StreamAccessibleFifo and StreamShiftChain
Feb 28, 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.
Two stream utilities introduced in SpinalHDL/SpinalHDL#1418 lacked documentation. This PR adds reference docs for both in
stream.rstunder the Utils section.StreamShiftChain
Shift-register pipeline chain (renamed from
StreamHistory). CreateslengthM2S pipeline stages with all intermediate states observable viaio.states.clearsignal documented (flushes pipeline)StreamAccessibleFifo
FIFO where all stored elements are simultaneously visible via
io.states. Pushes route to the first empty slot; elements shift toward output on pop.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.