Skip to content

SpiDevice: add guidelines for behaviour of CS pin upon bus failures #399

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2022

Conversation

newAM
Copy link
Member

@newAM newAM commented Aug 14, 2022

Currently the SpiDevice trait does not define the sequence of actions that occur after a bus error.

I discussed this with @Dirbaio in the matrix chat and the conclusion we reached was that this should be added to the documentation as a guideline to match what already exists for ExclusiveDevice. The rationale for a guideline instead of a requirement is that SPI error recovery is implementation specific.

@newAM newAM requested a review from a team as a code owner August 14, 2022 22:08
@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @eldruin (or someone else) soon.

Please see the contribution instructions for more information.

@Dirbaio
Copy link
Member

Dirbaio commented Aug 14, 2022

LGTM, could you do the same change to async's docs ?

@newAM
Copy link
Member Author

newAM commented Aug 14, 2022

LGTM, could you do the same change to async's docs ?

Good call. Made the change & rebased.

@newAM
Copy link
Member Author

newAM commented Aug 14, 2022

Should I add a changelog entry for this? I wasn't sure because it doesn't change anyone's impl.

@Dirbaio
Copy link
Member

Dirbaio commented Aug 14, 2022

IMO it's small enough that no changelog is fine, but feel free to add it if you want.

Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thank you!
I agree no changelog entry is necessary especially since we are still in alpha phase.
bors r+

@bors bors bot merged commit a1806f7 into rust-embedded:master Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants