mctp-estack: Add async feature gate, add blocking serial transport binding
#40
Conversation
Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: leongross <[email protected]> Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: leongross <[email protected]> Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: leongross <[email protected]> Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: leongross <[email protected]> Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: jonas loeffelholz <[email protected]> Signed-off-by: Marvin Gudel <[email protected]>
Signed-off-by: Marvin Gudel <[email protected]>
|
Should the |
mkj
left a comment
mkj
left a comment
There was a problem hiding this comment.
I think async makes sense as a default feature. If Router isn't being used then I don't think it would have any binary overhead, just some extra built dependencies for embassy-sync's dep tree.
| A `async` Router for embassy based applications is available | ||
| through the `embassy` feature. |
| - `embassy`: async `Router` for [Embassy](https://embassy.dev/) | ||
| - `async`: [embedded-io-async](https://docs.rs/embedded-io-async/0.6.1/embedded_io_async/) serial transport binding (enabled by `embassy` feature) |
| /// Read a frame synchronously. | ||
| /// This function blocks until at least one byte is available | ||
| #[cfg(not(feature = "async"))] | ||
| pub fn recv(&mut self, input: &mut impl Read) -> Result<&[u8]> { |
There was a problem hiding this comment.
Name it recv_sync() for consistency
| #[cfg(feature = "async")] | ||
| use embedded_io_async::{Read, Write}; | ||
|
|
||
| #[cfg(not(feature = "async"))] | ||
| use embedded_io::{Read, Write}; | ||
|
|
There was a problem hiding this comment.
For this serial module I'd be inclined to get rid of all the cfg and always include both async and blocking functionality. embedded_io_async is a small dependency.
cfg(not(feature = "async")) shouldn't be used since that prevents a program linking crates that use both modes. (More generally features should always be additive, where possible)
| /// Frame a MCTP packet into a serial frame, writing to `output`. | ||
| #[cfg(feature = "async")] | ||
| async fn frame_to_serial<W>( | ||
| p: &[u8], | ||
| output: &mut W, |
There was a problem hiding this comment.
Will need renaming to frame_to_serial_async or similar
3 participants
Puts async functionality and dependencies behind
asyncfeature gate.The serial transport binding was extended by blocking functionality using
embedded-io.