aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrant Miller <[email protected]>2024-02-03 17:04:20 -0600
committerGrant Miller <[email protected]>2024-02-03 17:04:20 -0600
commit87a52f5eadbff91ff4fe2df807aa4e7bb3b29d79 (patch)
treee415317d2c8d29256e7c5274bd132b5673651510
parent711dd120d1802dd43b003b2536a290a1c53cfeba (diff)
stm32/usart: Add doc links to buffered uarts
-rw-r--r--embassy-stm32/src/usart/buffered.rs4
-rw-r--r--embassy-stm32/src/usart/ringbuffered.rs2
2 files changed, 6 insertions, 0 deletions
diff --git a/embassy-stm32/src/usart/buffered.rs b/embassy-stm32/src/usart/buffered.rs
index c78752883..c11e3382f 100644
--- a/embassy-stm32/src/usart/buffered.rs
+++ b/embassy-stm32/src/usart/buffered.rs
@@ -140,11 +140,15 @@ pub struct BufferedUart<'d, T: BasicInstance> {
140} 140}
141 141
142/// Tx-only buffered UART 142/// Tx-only buffered UART
143///
144/// Created with [BufferedUart::split]
143pub struct BufferedUartTx<'d, T: BasicInstance> { 145pub struct BufferedUartTx<'d, T: BasicInstance> {
144 phantom: PhantomData<&'d mut T>, 146 phantom: PhantomData<&'d mut T>,
145} 147}
146 148
147/// Rx-only buffered UART 149/// Rx-only buffered UART
150///
151/// Created with [BufferedUart::split]
148pub struct BufferedUartRx<'d, T: BasicInstance> { 152pub struct BufferedUartRx<'d, T: BasicInstance> {
149 phantom: PhantomData<&'d mut T>, 153 phantom: PhantomData<&'d mut T>,
150} 154}
diff --git a/embassy-stm32/src/usart/ringbuffered.rs b/embassy-stm32/src/usart/ringbuffered.rs
index 4391bfef7..a0ab060a3 100644
--- a/embassy-stm32/src/usart/ringbuffered.rs
+++ b/embassy-stm32/src/usart/ringbuffered.rs
@@ -12,6 +12,8 @@ use crate::dma::ReadableRingBuffer;
12use crate::usart::{Regs, Sr}; 12use crate::usart::{Regs, Sr};
13 13
14/// Rx-only Ring-buffered UART Driver 14/// Rx-only Ring-buffered UART Driver
15///
16/// Created with [UartRx::into_ring_buffered]
15pub struct RingBufferedUartRx<'d, T: BasicInstance, RxDma: super::RxDma<T>> { 17pub struct RingBufferedUartRx<'d, T: BasicInstance, RxDma: super::RxDma<T>> {
16 _peri: PeripheralRef<'d, T>, 18 _peri: PeripheralRef<'d, T>,
17 ring_buf: ReadableRingBuffer<'d, RxDma, u8>, 19 ring_buf: ReadableRingBuffer<'d, RxDma, u8>,