nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-22 14:53:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2529 from GrantM11235/buffered-uart-doc-links

Browse Source 
stm32/usart: Add doc links to buffered uarts
This commit is contained in:
Dario Nieuwenhuis 2024-02-04 23:29:27 +01:00 committed by GitHub
commit e25eb6ca59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
embassy-stm32/src/usart/buffered.rs
View File

@ -140,11 +140,15 @@ pub struct BufferedUart<'d, T: BasicInstance> {
} }
/// Tx-only buffered UART /// Tx-only buffered UART
///
/// Created with [BufferedUart::split]
pub struct BufferedUartTx<'d, T: BasicInstance> { pub struct BufferedUartTx<'d, T: BasicInstance> {
phantom: PhantomData<&'d mut T>, phantom: PhantomData<&'d mut T>,
} }
/// Rx-only buffered UART /// Rx-only buffered UART
///
/// Created with [BufferedUart::split]
pub struct BufferedUartRx<'d, T: BasicInstance> { pub struct BufferedUartRx<'d, T: BasicInstance> {
phantom: PhantomData<&'d mut T>, phantom: PhantomData<&'d mut T>,
} }

2
embassy-stm32/src/usart/ringbuffered.rs
View File

@ -12,6 +12,8 @@ use crate::dma::ReadableRingBuffer;
use crate::usart::{Regs, Sr}; use crate::usart::{Regs, Sr};
/// Rx-only Ring-buffered UART Driver /// Rx-only Ring-buffered UART Driver
///
/// Created with [UartRx::into_ring_buffered]
pub struct RingBufferedUartRx<'d, T: BasicInstance, RxDma: super::RxDma<T>> { pub struct RingBufferedUartRx<'d, T: BasicInstance, RxDma: super::RxDma<T>> {
_peri: PeripheralRef<'d, T>, _peri: PeripheralRef<'d, T>,
ring_buf: ReadableRingBuffer<'d, RxDma, u8>, ring_buf: ReadableRingBuffer<'d, RxDma, u8>,