max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documents the nRF BufferedUarte problem

Browse Source 
Please see https://github.com/embassy-rs/embassy/issues/536 for the rationale.
This commit is contained in:
huntc
2021-12-12 17:47:38 +11:00
parent dce3f8c47d
commit dc3469b297
3 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
embassy-nrf/src/buffered_uarte.rs
View File

@ -1,6 +1,17 @@
//! Async buffered UART
//!
//! Please ee [uarte] to understand when [BufferedUarte] should be used.
//! WARNING!!! The functionality provided here is intended to be used only
//! in situations where hardware flow control are available i.e. CTS and RTS.
//! This is a problem that should be addressed at a later stage and can be
//! fully explained at https://github.com/embassy-rs/embassy/issues/536.
//!
//! Note that discarding a future from a read or write operation may lead to losing
//! data. For example, when using `futures_util::future::select` and completion occurs
//! on the "other" future, you should capture the incomplete future and continue to use
//! it for the next read or write. This pattern is a consideration for all IO, and not
//! just serial communications.
//!
//! Please also see [crate::uarte] to understand when [BufferedUarte] should be used.
use core::cmp::min;
use core::marker::PhantomData;

6
embassy-nrf/src/uarte.rs
View File

@ -2,14 +2,14 @@
//! Async UART
//!
//! Async UART is provided in two flavors - this one and also [buffered_uarte::BufferedUarte].
//! Async UART is provided in two flavors - this one and also [crate::buffered_uarte::BufferedUarte].
//! The [Uarte] here is useful for those use-cases where reading the UARTE peripheral is
//! exclusively awaited on. If the [Uarte] is required to be awaited on with some other future,
//! for example when using `futures_util::future::select`, then you should consider
//! [buffered_uarte::BufferedUarte] so that reads may continue while processing these
//! [crate::buffered_uarte::BufferedUarte] so that reads may continue while processing these
//! other futures. If you do not then you may lose data between reads.
//!
//! An advantage of the [Uarte] has over [buffered_uarte::BufferedUarte] is that less
//! An advantage of the [Uarte] has over [crate::buffered_uarte::BufferedUarte] is that less
//! memory may be used given that buffers are passed in directly to its read and write
//! methods.