Move all DMA related modules into a subfolder

Author: datdenkikniet

README.md

@@ -29,7 +29,7 @@ use stm32_eth::{
     hal::gpio::GpioExt,
     hal::rcc::RccExt,
     stm32::Peripherals,
-    RingEntry,
+    dma::{RxRingEntry, TxRingEntry},
     EthPins,
 };
 use fugit::RateExtU32;
@@ -56,8 +56,8 @@ fn main() {
         rx_d1: gpioc.pc5,
     };
 
-    let mut rx_ring: [RingEntry<_>; 16] = Default::default();
-    let mut tx_ring: [RingEntry<_>; 8] = Default::default();
+    let mut rx_ring: [RxRingEntry; 16] = Default::default();
+    let mut tx_ring: [TxRingEntry; 8] = Default::default();
     let (mut eth_dma, _eth_mac) = stm32_eth::new(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,

examples/arp.rs

@@ -22,7 +22,7 @@ use stm32_eth::{
 
 pub mod common;
 
-use stm32_eth::{RingEntry, TxError};
+use stm32_eth::dma::{RxRingEntry, TxError, TxRingEntry};
 
 const PHY_ADDR: u8 = 0;
 
@@ -42,8 +42,8 @@ fn main() -> ! {
 
     let (eth_pins, mdio, mdc) = common::setup_pins(gpio);
 
-    let mut rx_ring: [RingEntry<_>; 2] = Default::default();
-    let mut tx_ring: [RingEntry<_>; 2] = Default::default();
+    let mut rx_ring: [RxRingEntry; 2] = Default::default();
+    let mut tx_ring: [TxRingEntry; 2] = Default::default();
 
     let (mut eth_dma, eth_mac) = stm32_eth::new(
         ethernet.mac,

examples/ip.rs

@@ -22,7 +22,7 @@ use smoltcp::wire::{EthernetAddress, IpAddress, IpCidr, Ipv4Address};
 
 pub mod common;
 
-use stm32_eth::RingEntry;
+use stm32_eth::dma::{RxRingEntry, TxRingEntry};
 
 const SRC_MAC: [u8; 6] = [0x00, 0x00, 0xDE, 0xAD, 0xBE, 0xEF];
 
@@ -42,8 +42,8 @@ fn main() -> ! {
 
     let (eth_pins, _mdio, _mdc) = common::setup_pins(gpio);
 
-    let mut rx_ring: [RingEntry<_>; 2] = Default::default();
-    let mut tx_ring: [RingEntry<_>; 2] = Default::default();
+    let mut rx_ring: [RxRingEntry; 2] = Default::default();
+    let mut tx_ring: [TxRingEntry; 2] = Default::default();
     let (mut eth_dma, _eth_mac) = stm32_eth::new(
         ethernet.mac,
         ethernet.mmc,

examples/pktgen.rs

@@ -17,7 +17,7 @@ use stm32_eth::{
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
-use stm32_eth::{RingEntry, TxError};
+use stm32_eth::dma::{RxRingEntry, TxError, TxRingEntry};
 
 pub mod common;
 
@@ -41,8 +41,8 @@ fn main() -> ! {
     defmt::info!("Enabling ethernet...");
     let (eth_pins, mdio, mdc) = common::setup_pins(gpio);
 
-    let mut rx_ring: [RingEntry<_>; 2] = Default::default();
-    let mut tx_ring: [RingEntry<_>; 2] = Default::default();
+    let mut rx_ring: [RxRingEntry; 2] = Default::default();
+    let mut tx_ring: [TxRingEntry; 2] = Default::default();
     let (mut eth_dma, eth_mac) = stm32_eth::new(
         ethernet.mac,
         ethernet.mmc,

examples/rtic-echo.rs

@@ -28,7 +28,10 @@ mod app {
     use ieee802_3_miim::{phy::PhySpeed, Phy};
     use systick_monotonic::Systick;
 
-    use stm32_eth::{mac::Speed, EthernetDMA, RxRingEntry, TxRingEntry};
+    use stm32_eth::{
+        dma::{EthernetDMA, RxRingEntry, TxRingEntry},
+        mac::Speed,
+    };
 
     use smoltcp::{
         iface::{self, Interface, SocketHandle},

src/desc.rs renamed to src/dma/desc.rs

@@ -1,15 +1,34 @@
+//! Ethernet DMA access and configuration.
+
 use core::borrow::Borrow;
 
 use cortex_m::peripheral::NVIC;
 
 use crate::{
     peripherals::{ETHERNET_DMA, ETHERNET_MAC},
-    rx::{RxPacket, RxRing},
     stm32::Interrupt,
-    tx::TxRing,
-    RxError, RxRingEntry, TxError, TxRingEntry,
 };
 
+#[cfg(feature = "smoltcp-phy")]
+mod smoltcp_phy;
+#[cfg(feature = "smoltcp-phy")]
+pub use smoltcp_phy::*;
+
+pub(crate) mod desc;
+
+pub(crate) mod ring;
+
+mod rx;
+use rx::RxRing;
+pub use rx::{RxError, RxPacket, RxRingEntry};
+
+mod tx;
+use tx::TxRing;
+pub use tx::{TxError, TxRingEntry};
+
+/// From the datasheet: *VLAN Frame maxsize = 1522*
+pub(crate) const MTU: usize = 1522;
+
 /// Ethernet DMA.
 pub struct EthernetDMA<'rx, 'tx> {
     eth_dma: ETHERNET_DMA,
@@ -173,8 +192,11 @@ impl<'rx, 'tx> EthernetDMA<'rx, 'tx> {
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Debug, Clone, Copy)]
 pub struct InterruptReasonSummary {
+    /// The interrupt was caused by an RX event.
     pub is_rx: bool,
+    /// The interrupt was caused by an TX event.
     pub is_tx: bool,
+    /// The interrupt was caused by an error event.
     pub is_error: bool,
 }
 

src/dma.rs renamed to src/dma/mod.rs

@@ -1,7 +1,7 @@
 use aligned::{Aligned, A8};
 use core::ops::{Deref, DerefMut};
 
-use crate::{RxDescriptor, TxDescriptor, MTU};
+use super::{rx::RxDescriptor, tx::TxDescriptor, MTU};
 
 pub trait RingDescriptor {
     fn setup(&mut self, buffer: *const u8, len: usize, next: Option<&Self>);

src/ring.rs renamed to src/dma/ring.rs

@@ -6,7 +6,7 @@ use core::{
     sync::atomic::{self, Ordering},
 };
 
-use crate::{
+use super::{
     desc::Descriptor,
     ring::{RingDescriptor, RingEntry},
 };
@@ -173,6 +173,7 @@ impl RxRingEntry {
     }
 }
 
+/// A received packet.
 pub struct RxPacket<'a> {
     entry: &'a mut RxRingEntry,
     length: usize,
@@ -199,7 +200,7 @@ impl<'a> Drop for RxPacket<'a> {
 }
 
 impl<'a> RxPacket<'a> {
-    // Pass back to DMA engine
+    /// Pass the received packet back to the DMA engine
     pub fn free(self) {
         drop(self)
     }

src/rx.rs renamed to src/dma/rx.rs

@@ -1,4 +1,4 @@
-use crate::{rx::RxPacket, tx::TxError, EthernetDMA};
+use super::{rx::RxPacket, tx::TxError, EthernetDMA};
 use core::intrinsics::transmute;
 use smoltcp::phy::{ChecksumCapabilities, Device, DeviceCapabilities, RxToken, TxToken};
 use smoltcp::time::Instant;