Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs/stdlib/fifo: document fifo stream interfaces#1475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
purdeaandrei wants to merge1 commit intoamaranth-lang:main
base:main
Choose a base branch
Loading
frompurdeaandrei:document_fifo_stream_interfaces

Conversation

@purdeaandrei
Copy link
Contributor

Rendered document:
image

@whitequark
Copy link
Member

These interfaces are meant to be transitionary, and the FIFOs themselves should be adapted to be stream-first. However, that would require some amount of design work and an RFC.

I realize we should probably document these things as they are in the interim, but I'm going to think for a while abouthow we document them.

@purdeaandrei
Copy link
ContributorAuthor

I understand, the renamed signals look not so idiomatic.

Just... my perspective as a new user was:

  1. I read the Data streams page, including the Completed pipeline example where I saw SyncFIFOBuffered connected up as a stream
  2. I got to the FIFO page, and I saw no sign of stream interface, so my first reaction was: something's not quite right, and I had to look in the source code to figure it out.

Are the names of w_stream/r_stream likely to change for the FIFOs?
Cause if what's gonna happen is that the old single wire non-stream signals will disappear, and the fifo will only support the stream interface, then it sounds more like we should be deprecating the single wires, and documenting w_stream/r_stream.

@whitequark
Copy link
Member

Are the names of w_stream/r_stream likely to change for the FIFOs?
Cause if what's gonna happen is that the old single wire non-stream signals will disappear, and the fifo will only support the stream interface, then it sounds more like we should be deprecating the single wires, and documenting w_stream/r_stream.

I'm actually considering whether or not we should deprecate the interface entirely and make a new stream-only one. This is undecided yet.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@whitequarkwhitequarkAwaiting requested review from whitequarkwhitequark is a code owner

At least 0 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@purdeaandrei@whitequark

[8]ページ先頭

©2009-2025 Movatter.jp