Skip to content

Clarify the request-reply contract between host and device #46

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Closed
bruno-f-cruz wants to merge 9 commits into from
Closed

Clarify the request-reply contract between host and device #46

bruno-f-cruz wants to merge 9 commits into from

Conversation

@bruno-f-cruz
Copy link
Member

@bruno-f-cruz bruno-f-cruz commented Apr 9, 2024

This PR addresses issues #26 and #9 by adding clarifying language to the document.

To summarize:

  • Clarify that for each Write/Read message a reply is expected from the same register
  • Strongly discourage the use of polymorphic register behavior. All messages from a given register should have the same payload type and size. The "quantity" or "function" of the register should also not be dependent of the message type.

@bruno-f-cruz bruno-f-cruz added the documentation Improvements or additions to documentation label Apr 9, 2024
@bruno-f-cruz bruno-f-cruz linked an issue Apr 9, 2024 that may be closed by this pull request
Discourage register polymorphic behavior #26
Closed
4 tasks
glopesdev
glopesdev reviewed Apr 9, 2024
View reviewed changes
@bruno-f-cruz bruno-f-cruz force-pushed the docs-clarify-message-protocol-req-rply branch from e5e55b7 to ae0a721 Compare April 10, 2024 02:04
@bruno-f-cruz bruno-f-cruz requested a review from glopesdev April 10, 2024 02:04
bruno-f-cruz
bruno-f-cruz commented Apr 18, 2024
View reviewed changes
bruno-f-cruz
bruno-f-cruz commented Apr 18, 2024
View reviewed changes
glopesdev
glopesdev reviewed Jan 2, 2025
View reviewed changes
@bruno-f-cruz bruno-f-cruz requested a review from glopesdev January 6, 2025 04:38
glopesdev
glopesdev reviewed Jan 9, 2025
View reviewed changes
@glopesdev glopesdev self-requested a review January 9, 2025 23:00
glopesdev
glopesdev reviewed Jan 9, 2025
View reviewed changes
@bruno-f-cruz bruno-f-cruz linked an issue Mar 27, 2025 that may be closed by this pull request
Explicitly state message type req-rply convention #9
Closed
@CLAassistant
Copy link

CLAassistant commented Jun 9, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@glopesdev glopesdev force-pushed the docs-clarify-message-protocol-req-rply branch from 47eac57 to a8f4b34 Compare October 27, 2025 15:56
@glopesdev glopesdev force-pushed the docs-clarify-message-protocol-req-rply branch from a8f4b34 to 3ea50f2 Compare November 1, 2025 10:48
@glopesdev glopesdev mentioned this pull request Nov 1, 2025
Merged
@bruno-f-cruz
Copy link
Member Author

bruno-f-cruz commented Nov 2, 2025

Superseeded by #181

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

Reviewers

@artursilva0 artursilva0 Awaiting requested review from artursilva0

@filcarv filcarv Awaiting requested review from filcarv

@glopesdev glopesdev Awaiting requested review from glopesdev

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Discourage register polymorphic behavior Explicitly state message type req-rply convention

4 participants

@bruno-f-cruz @CLAassistant @glopesdev