Skip to content
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

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 3 commits into from
+42 −4

Conversation

bruno-f-cruz
Copy link
Member

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
Open
4 tasks
@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 commented Apr 18, 2024
View reviewed changes
BinaryProtocol-8bit.md Outdated Show resolved Hide resolved
bruno-f-cruz
bruno-f-cruz commented Apr 18, 2024
View reviewed changes
BinaryProtocol-8bit.md Outdated Show resolved Hide resolved
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
2 participants
@bruno-f-cruz @glopesdev