CG channel

Author: burrbull

CHANGELOG.md

@@ -42,6 +42,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Split `Stream` trait on `Stream` and `StreamISR`.
+  Use const generics for `Stream` and `Channel`.
 - [breaking-change] `Timer::new` now just initializes peripheral.
   Use `.start_count_down` to start count, `pwm` or `delay` on `Timer` struct.
 - Add `Spi::new`, `I2s::new, `spi::Instance` and deprecate `Spi:spix`,

examples/adc_dma_rtic.rs

@@ -11,7 +11,7 @@ use stm32f4xx_hal::{
         config::{AdcConfig, Dma, SampleTime, Scan, Sequence},
         Adc, Temperature,
     },
-    dma::{config::DmaConfig, Channel0, PeripheralToMemory, Stream0, StreamsTuple, Transfer},
+    dma::{config::DmaConfig, PeripheralToMemory, Stream0, StreamsTuple, Transfer},
     prelude::*,
     signature::{VtempCal110, VtempCal30},
     stm32,
@@ -20,8 +20,7 @@ use stm32f4xx_hal::{
 
 const POLLING_PERIOD: u32 = 168_000_000 / 2;
 
-type DMATransfer =
-    Transfer<Stream0<DMA2>, Channel0, Adc<ADC1>, PeripheralToMemory, &'static mut [u16; 2]>;
+type DMATransfer = Transfer<Stream0<DMA2>, Adc<ADC1>, PeripheralToMemory, &'static mut [u16; 2], 0>;
 
 #[rtic::app(device = stm32f4xx_hal::stm32, peripherals = true, monotonic = rtic::cyccnt::CYCCNT)]
 const APP: () = {

examples/i2s-audio-out-dma.rs

@@ -51,7 +51,7 @@ use stm32_i2s_v12x::{MasterClock, MasterConfig, Polarity, TransmitMode};
 use stm32f4xx_hal::delay::Delay;
 use stm32f4xx_hal::dma::config::DmaConfig;
 use stm32f4xx_hal::dma::MemoryToPeripheral;
-use stm32f4xx_hal::dma::{Channel0, Stream5, StreamsTuple, Transfer};
+use stm32f4xx_hal::dma::{Stream5, StreamsTuple, Transfer};
 use stm32f4xx_hal::gpio::gpioa::PA4;
 use stm32f4xx_hal::gpio::gpioc::{PC10, PC12, PC7};
 use stm32f4xx_hal::gpio::Alternate;
@@ -212,7 +212,6 @@ fn main() -> ! {
 
 type I2sDmaTransfer = Transfer<
     Stream5<DMA1>,
-    Channel0,
     stm32_i2s_v12x::I2s<
         I2s<
             SPI3,
@@ -227,6 +226,7 @@ type I2sDmaTransfer = Transfer<
     >,
     MemoryToPeripheral,
     &'static mut [u16; SINE_SAMPLES * 2],
+    0,
 >;
 
 /// DMA transfer handoff from main() to interrupt handler

src/dma/mod.rs

@@ -367,10 +367,11 @@ where
     }
 
     #[inline(always)]
-    fn set_channel<C: Channel>(&mut self, channel: C) {
-        unsafe { Self::st() }
-            .cr
-            .modify(|_, w| w.chsel().bits(channel.bits()));
+    fn set_channel<const C: u8>(&mut self)
+    where
+        ChannelX<C>: Channel,
+    {
+        unsafe { Self::st() }.cr.modify(|_, w| w.chsel().bits(C));
     }
 
     #[inline(always)]
@@ -645,30 +646,28 @@ dma_stream!(
 #[derive(Debug, Clone, Copy)]
 pub struct ChannelX<const C: u8>;
 
-impl<const C: u8> Bits<u8> for ChannelX<C> {
-    fn bits(self) -> u8 {
-        C
-    }
+macro_rules! dma_channel {
+    ($(($name:ident, $value:literal)),+ $(,)*) => {
+        $(
+            impl Channel for ChannelX<$value> {}
+            pub type $name = ChannelX<$value>;
+        )+
+    };
 }
 
-impl<const C: u8> Channel for ChannelX<C> {
-    fn new() -> Self {
-        Self
-    }
-}
-pub type Channel0 = ChannelX<0>;
-pub type Channel1 = ChannelX<1>;
-pub type Channel2 = ChannelX<2>;
-pub type Channel3 = ChannelX<3>;
-pub type Channel4 = ChannelX<4>;
-pub type Channel5 = ChannelX<5>;
-pub type Channel6 = ChannelX<6>;
-pub type Channel7 = ChannelX<7>;
+dma_channel!(
+    (Channel0, 0),
+    (Channel1, 1),
+    (Channel2, 2),
+    (Channel3, 3),
+    (Channel4, 4),
+    (Channel5, 5),
+    (Channel6, 6),
+    (Channel7, 7),
+);
 
 #[cfg(any(feature = "stm32f413", feature = "stm32f423"))]
-pub type Channel8 = ChannelX<8>;
-#[cfg(any(feature = "stm32f413", feature = "stm32f423"))]
-pub type Channel9 = ChannelX<9>;
+dma_channel!((Channel8, 8), (Channel9, 9),);
 
 /// Contains types related to DMA configuration.
 pub mod config {
@@ -870,13 +869,12 @@ pub mod config {
 }
 
 /// DMA Transfer.
-pub struct Transfer<STREAM, CHANNEL, PERIPHERAL, DIRECTION, BUF>
+pub struct Transfer<STREAM, PERIPHERAL, DIRECTION, BUF, const CHANNEL: u8>
 where
     STREAM: Stream,
     PERIPHERAL: PeriAddress,
 {
     stream: STREAM,
-    _channel: PhantomData<CHANNEL>,
     peripheral: PERIPHERAL,
     _direction: PhantomData<DIRECTION>,
     buf: Option<BUF>,
@@ -885,12 +883,12 @@ where
     transfer_length: u16,
 }
 
-impl<STREAM, CHANNEL, PERIPHERAL, BUF>
-    Transfer<STREAM, CHANNEL, PERIPHERAL, MemoryToPeripheral, BUF>
+impl<STREAM, PERIPHERAL, BUF, const CHANNEL: u8>
+    Transfer<STREAM, PERIPHERAL, MemoryToPeripheral, BUF, CHANNEL>
 where
     STREAM: Stream,
-    CHANNEL: Channel,
-    PERIPHERAL: PeriAddress + DMASet<STREAM, CHANNEL, MemoryToPeripheral>,
+    ChannelX<CHANNEL>: Channel,
+    PERIPHERAL: PeriAddress + DMASet<STREAM, MemoryToPeripheral, CHANNEL>,
     BUF: StaticReadBuffer<Word = <PERIPHERAL as PeriAddress>::MemSize>,
 {
     /// Configures the DMA stream to the correct channel for the peripheral, configures source and
@@ -922,7 +920,6 @@ where
 
         Self {
             stream,
-            _channel: PhantomData,
             peripheral,
             _direction: PhantomData,
             buf: Some(buf),
@@ -1017,12 +1014,12 @@ where
     }
 }
 
-impl<STREAM, CHANNEL, PERIPHERAL, BUF>
-    Transfer<STREAM, CHANNEL, PERIPHERAL, PeripheralToMemory, BUF>
+impl<STREAM, PERIPHERAL, BUF, const CHANNEL: u8>
+    Transfer<STREAM, PERIPHERAL, PeripheralToMemory, BUF, CHANNEL>
 where
     STREAM: Stream,
-    CHANNEL: Channel,
-    PERIPHERAL: PeriAddress + DMASet<STREAM, CHANNEL, PeripheralToMemory>,
+    ChannelX<CHANNEL>: Channel,
+    PERIPHERAL: PeriAddress + DMASet<STREAM, PeripheralToMemory, CHANNEL>,
     BUF: StaticWriteBuffer<Word = <PERIPHERAL as PeriAddress>::MemSize>,
 {
     /// Configures the DMA stream to the correct channel for the peripheral, configures source and
@@ -1054,7 +1051,6 @@ where
 
         Self {
             stream,
-            _channel: PhantomData,
             peripheral,
             _direction: PhantomData,
             buf: Some(buf),
@@ -1152,12 +1148,12 @@ where
     }
 }
 
-impl<STREAM, CHANNEL, PERIPHERAL, BUF, S>
-    Transfer<STREAM, CHANNEL, PERIPHERAL, MemoryToMemory<S>, BUF>
+impl<STREAM, PERIPHERAL, BUF, S, const CHANNEL: u8>
+    Transfer<STREAM, PERIPHERAL, MemoryToMemory<S>, BUF, CHANNEL>
 where
     STREAM: Stream,
-    CHANNEL: Channel,
-    PERIPHERAL: PeriAddress + DMASet<STREAM, CHANNEL, MemoryToMemory<S>>,
+    ChannelX<CHANNEL>: Channel,
+    PERIPHERAL: PeriAddress + DMASet<STREAM, MemoryToMemory<S>, CHANNEL>,
     MemoryToMemory<S>: PeriAddress,
     BUF: StaticWriteBuffer<Word = <PERIPHERAL as PeriAddress>::MemSize>,
 {
@@ -1192,7 +1188,6 @@ where
 
         Self {
             stream,
-            _channel: PhantomData,
             peripheral,
             _direction: PhantomData,
             buf: Some(buf),
@@ -1252,12 +1247,13 @@ where
     }
 }
 
-impl<STREAM, CHANNEL, PERIPHERAL, DIR, BUF> Transfer<STREAM, CHANNEL, PERIPHERAL, DIR, BUF>
+impl<STREAM, PERIPHERAL, DIR, BUF, const CHANNEL: u8>
+    Transfer<STREAM, PERIPHERAL, DIR, BUF, CHANNEL>
 where
     STREAM: Stream,
-    CHANNEL: Channel,
+    ChannelX<CHANNEL>: Channel,
     DIR: Direction,
-    PERIPHERAL: PeriAddress + DMASet<STREAM, CHANNEL, DIR>,
+    PERIPHERAL: PeriAddress + DMASet<STREAM, DIR, CHANNEL>,
 {
     /// Starts the transfer, the closure will be executed right after enabling the stream.
     pub fn start<F>(&mut self, f: F)
@@ -1385,7 +1381,7 @@ where
         stream.disable();
 
         // Set the channel
-        stream.set_channel(CHANNEL::new());
+        stream.set_channel::<CHANNEL>();
 
         // Set peripheral to memory mode
         stream.set_direction(DIR::new());
@@ -1583,7 +1579,8 @@ where
     }
 }
 
-impl<STREAM, CHANNEL, PERIPHERAL, DIR, BUF> Drop for Transfer<STREAM, CHANNEL, PERIPHERAL, DIR, BUF>
+impl<STREAM, PERIPHERAL, DIR, BUF, const CHANNEL: u8> Drop
+    for Transfer<STREAM, PERIPHERAL, DIR, BUF, CHANNEL>
 where
     STREAM: Stream,
     PERIPHERAL: PeriAddress,

src/dma/traits.rs

@@ -95,7 +95,9 @@ pub trait Stream: StreamISR + Sealed {
     fn disable(&mut self);
 
     /// Set the channel for the (chsel) the DMA stream.
-    fn set_channel<C: Channel>(&mut self, channel: C);
+    fn set_channel<const C: u8>(&mut self)
+    where
+        ChannelX<C>: Channel;
 
     /// Set the priority (pl) the DMA stream.
     fn set_priority(&mut self, priority: config::Priority);
@@ -279,24 +281,21 @@ macro_rules! tim_channels {
 }
 
 /// A channel that can be configured on a DMA stream.
-pub trait Channel: Bits<u8> {
-    /// Returns a new instance of the type.
-    fn new() -> Self;
-}
+pub trait Channel {}
 
 /// Trait to mark a set of Stream, Channel and Direction for a Peripheral as correct together.
 ///
 /// # Safety
 ///
 /// Memory corruption might occur if this trait is implemented for an invalid combination.
-pub unsafe trait DMASet<STREAM, CHANNEL, DIRECTION> {}
+pub unsafe trait DMASet<STREAM, DIRECTION, const CHANNEL: u8> {}
 
 tim_channels!(CCR1, CCR2, CCR3, CCR4, DMAR, ARR);
 
 macro_rules! dma_map {
     ($(($Stream:ty, $C:literal, $Peripheral:ty, $Dir:ty)),+ $(,)*) => {
         $(
-            unsafe impl DMASet<$Stream, ChannelX<$C>, $Dir> for $Peripheral {}
+            unsafe impl DMASet<$Stream, $Dir, $C> for $Peripheral {}
         )+
     };
 }

src/i2s.rs

@@ -446,10 +446,10 @@ mod dma {
     }
 
     /// DMA is available for I2S based on the underlying implementations for SPI
-    unsafe impl<SPI, PINS, MODE, STREAM, CHANNEL, DIR> DMASet<STREAM, CHANNEL, DIR>
+    unsafe impl<SPI, PINS, MODE, STREAM, DIR, const CHANNEL: u8> DMASet<STREAM, DIR, CHANNEL>
         for stm32_i2s_v12x::I2s<I2s<SPI, PINS>, MODE>
     where
-        SPI: DMASet<STREAM, CHANNEL, DIR>,
+        SPI: DMASet<STREAM, DIR, CHANNEL>,
     {
     }
 }