-
Notifications
You must be signed in to change notification settings - Fork 201
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
I2c: simplify, expand docs, document shared bus usage. #440
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with the analysis and looks good to me, thank you!
I just added some documentation improvements.
TODO:
- update changelog
Done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, let's get this merged.
Thank you for your work!
bors r+
445: bus/i2c: add RefCell, CriticalSection and Mutex shared bus implementations. r=eldruin a=Dirbaio Requires #440 Same as #443 but for I2C. This adds a few bus sharing implementations, with varying tradeoffs: - `RefCellDevice`: single thread only - `CriticalSectionDevice`: thread-safe, coarse locking, nostd. - `MutexDevice`: thread-safe, fine-grained locking, std only. Co-authored-by: Dario Nieuwenhuis <dirbaio@dirbaio.net>
Matches changes made in rust-embedded/embedded-hal#440
Matches changes made in rust-embedded/embedded-hal#440
Depends on #441 -- check that one out first.This does some simplifications to the trait that I think we should do:
transaction
. This way HALs have to implement just that.write_iter
andwrite_iter_read
. The reason is that they're quite inefficient, especially with DMA implementations. We've already removed these on other traits, so I think we should do as well here.transaction_iter
. I don't think it's much useful in practice, because the way iterators work all the yieldedOperation
s must have the same lifetime. This means that, even if the user can generate theOperation
s on the fly, they can't allocate buffers for these on the fly, all buffers must be pre-allocated. So it's not useful for, say, streaming a large transfer by reusing some small buffer repeatedly. See I2C transaction_iter should take an iterator of mutable references #367read
andwrite
, I think they're clearer.It also specifies how i2c bus sharing is supposed to work. This is an alternative to #392 . After the discussions there, I don't think we should split I2C into Bus and Device anymore. For SPI it makes sense, because drivers want to enforce that there's a CS pin (
SpiDevice
) or not (SpiBus
). This is not the case with I2C, the API is exactly the same in the shared and non-shared case. Drivers shouldn't care which case it is.So all we have to do to "support" bus sharing is docs, This PR does: