rust/va108xx-rs
6
0
Fork 0
Code Issues Pull Requests Projects Releases 19 Wiki Activity

doc improvements

Browse Source
This commit is contained in:
Robin Müller 2025-03-07 16:22:13 +01:00
parent 8cdee8b733
commit 102d11114a
Signed by: muellerr
GPG Key ID: A649FB78196E3849
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
va108xx-hal/src/uart/mod.rs
View File

@ -1,5 +1,12 @@
//! # API for the UART peripheral
//!
//! The core of this API are the [Uart], [UartBase], [Rx] and [Tx] structures.
//! The RX structure also has a dedicated [RxWithInterrupt] variant which allows reading the receiver
//! using interrupts.
//!
//! The [rx_asynch] and [tx_asynch] modules provide an asynchronous non-blocking API for the UART
//! peripheral.
//!
//! ## Examples
//!
//! - [UART simple example](https://egit.irs.uni-stuttgart.de/rust/va108xx-rs/src/branch/main/examples/simple/examples/uart.rs)