gpdma: refactoring channels

Author: astapleton

Cargo.toml

@@ -50,6 +50,11 @@ stm32h562 = ["stm32h5/stm32h562", "device-selected", "rm0481", "h56x_h573"]
 stm32h563 = ["stm32h5/stm32h563", "device-selected", "rm0481", "h56x_h573", "sdmmc2", "ethernet"]
 stm32h573 = ["stm32h5/stm32h573", "device-selected", "rm0481", "h56x_h573", "otfdec", "sdmmc2", "ethernet"]
 
+# Flags for async APIs
+futures = ["dep:futures-util"]
+gpdma-futures = ["futures"]
+async = ["gpdma-futures"]
+
 # Flags for examples
 log = ["dep:log"]
 log-itm = ["log"]
@@ -71,7 +76,7 @@ embedded-hal = "1.0.0"
 defmt = { version = "1.0.0", optional = true }
 paste = "1.0.15"
 log = { version = "0.4.20", optional = true}
-futures-util = { version = "0.3", default-features = false, features = ["async-await-macro"]}
+futures-util = { version = "0.3", default-features = false, features = ["async-await-macro"], optional = true}
 stm32-usbd = "0.8.0"
 
 [dev-dependencies]

src/gpdma.rs

@@ -89,6 +89,7 @@ use embedded_dma::{ReadBuffer, Word as DmaWord, WriteBuffer};
 
 mod ch;
 pub mod config;
+#[cfg(feature = "gpdma-futures")]
 mod future;
 pub mod periph;
 
@@ -102,7 +103,6 @@ use config::{
     PeripheralSource, PeripheralToMemory, PeripheralToPeripheral,
     PeripheralToPeripheralDirection, TransferDirection, TransferType,
 };
-use future::InstanceWaker;
 
 /// Supported word types for the STM32H5 GPDMA implementation.
 ///
@@ -148,9 +148,7 @@ impl<DMA: Instance> GpdmaExt<DMA> for DMA {
 }
 
 #[allow(private_bounds)]
-pub trait Instance:
-    Sealed + InstanceWaker + Deref<Target = gpdma1::RegisterBlock>
-{
+pub trait Instance: Sealed + Deref<Target = gpdma1::RegisterBlock> {
     type Rec: ResetEnable;
 
     fn ptr() -> *const gpdma1::RegisterBlock;

src/gpdma/ch.rs

@@ -1,7 +1,5 @@
 use core::{marker::PhantomData, ops::Deref};
 
-use futures_util::task::AtomicWaker;
-
 use crate::stm32::gpdma1::{
     self,
     ch::{CR, DAR, FCR, LBAR, SAR, SR, TR1, TR2},
@@ -14,7 +12,6 @@ use super::{
         AddressingMode, AhbPort, HardwareRequest, PeripheralRequest,
         PeripheralSource, Priority, TransferDirection, TransferType,
     },
-    future::ChannelWaker,
     DmaConfig, Error, Instance, Word,
 };
 
@@ -539,8 +536,6 @@ pub(super) trait Channel {
     /// Disable transfer interrupts for the channel. It is expected that this will be called from
     /// an interrupt handler after a transfer is completed.
     fn disable_transfer_interrupts(&self);
-
-    fn waker(&self) -> &'static AtomicWaker;
 }
 
 impl<DMA, CH, const N: usize> Channel for DmaChannelRef<DMA, CH, N>
@@ -744,17 +739,19 @@ where
             w.tcie().disabled().dteie().disabled().useie().disabled()
         });
     }
-
-    fn waker(&self) -> &'static AtomicWaker {
-        self.ch.waker()
-    }
 }
 
+#[cfg(feature = "gpdma-futures")]
+pub use super::future::DmaChannel;
+
 /// DmaChannel trait provides the API contract that all GPDMA channels exposed to the user
 /// implement.
+#[cfg(not(feature = "gpdma-futures"))]
 #[allow(private_bounds)]
 pub trait DmaChannel: Channel {}
 
+#[cfg(not(feature = "gpdma-futures"))]
+#[allow(private_bounds)]
 impl<DMA, CH, const N: usize> DmaChannel for DmaChannelRef<DMA, CH, N>
 where
     DMA: Instance,

src/gpdma/future.rs

@@ -13,15 +13,29 @@ use crate::stm32::{GPDMA1, GPDMA2};
 
 use super::{
     ch::{
-        ChannelRegs, DmaChannel, DmaChannel0, DmaChannel1, DmaChannel2,
-        DmaChannel3, DmaChannel4, DmaChannel5, DmaChannel6, DmaChannel7,
-        DmaChannelImpl, DmaChannelRef,
+        Channel, ChannelRegs, DmaChannel0, DmaChannel1,
+        DmaChannel2, DmaChannel3, DmaChannel4, DmaChannel5, DmaChannel6,
+        DmaChannel7, DmaChannelRef,
     },
     DmaTransfer, Error, Instance,
 };
 
 #[allow(private_bounds)]
-impl<'a, CH: DmaChannel> IntoFuture for DmaTransfer<'a, CH> {
+pub trait DmaChannel: Channel + ChannelWaker {}
+
+impl<DMA, CH, const N: usize> DmaChannel for DmaChannelRef<DMA, CH, N>
+where
+    DMA: Instance + InstanceWaker,
+    CH: ChannelRegs,
+    Self: Deref<Target = CH>,
+{
+}
+
+#[allow(private_bounds)]
+impl<'a, CH> IntoFuture for DmaTransfer<'a, CH>
+where
+    CH: DmaChannel,
+{
     type Output = Result<(), Error>;
     type IntoFuture = DmaTransferFuture<'a, CH>;
 
@@ -76,7 +90,7 @@ impl<'a, CH: DmaChannel> Unpin for DmaTransferFuture<'a, CH> {}
 
 impl<'a, CH> Future for DmaTransferFuture<'a, CH>
 where
-    CH: DmaChannel,
+    CH: DmaChannel + ChannelWaker,
 {
     type Output = Result<(), Error>;
 
@@ -91,11 +105,11 @@ where
 }
 
 #[allow(private_bounds)]
-impl<DMA, CH, const N: usize> DmaChannelImpl<DmaChannelRef<DMA, CH, N>>
+impl<DMA, CH, const N: usize> DmaChannelRef<DMA, CH, N>
 where
-    DMA: Instance,
+    DMA: Instance + InstanceWaker,
     CH: ChannelRegs,
-    DmaChannelRef<DMA, CH, N>: ChannelRegs,
+    Self: Deref<Target = CH>,
 {
     #[inline(always)]
     fn handle_interrupt() {
@@ -105,6 +119,18 @@ where
     }
 }
 
+impl<DMA, CH, const N: usize> ChannelWaker for DmaChannelRef<DMA, CH, N>
+where
+    DMA: Instance + InstanceWaker,
+    CH: ChannelRegs,
+    Self: Deref<Target = CH>,
+{
+    #[inline(always)]
+    fn waker(&self) -> &'static AtomicWaker {
+        DMA::waker(N)
+    }
+}
+
 macro_rules! gpdma_irq {
     ($GPDMA:ident, $CH:literal) => {
         paste::item! {
@@ -125,17 +151,6 @@ pub(super) trait ChannelWaker {
     fn waker(&self) -> &'static AtomicWaker;
 }
 
-impl<DMA, CH, const N: usize> ChannelWaker for DmaChannelRef<DMA, CH, N>
-where
-    DMA: Instance,
-    CH: ChannelRegs,
-{
-    #[inline(always)]
-    fn waker(&self) -> &'static AtomicWaker {
-        DMA::waker(N)
-    }
-}
-
 mod gpdma1 {
     use super::*;