Merge pull request #15 from thalesfragoso/pins

Better family support and easier configuration

Author: astro

.travis.yml

@@ -2,24 +2,24 @@ language: rust
 matrix:
   include:
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f407'
+      env: FEATURES='stm32f407'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f417'
+      env: FEATURES='stm32f417'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f427'
+      env: FEATURES='stm32f427'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f429'
+      env: FEATURES='stm32f429'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f437'
+      env: FEATURES='stm32f437'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f439'
+      env: FEATURES='stm32f439'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f469'
+      env: FEATURES='stm32f469'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/stm32f479'
+      env: FEATURES='stm32f479'
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/rt nucleo-f429zi' ARGS="--release --target=thumbv7em-none-eabihf --example=pktgen"
+      env: FEATURES='stm32f429' ARGS="--release --target=thumbv7em-none-eabihf --example=pktgen"
     - rust: nightly
-      env: FEATURES='stm32f4xx-hal/rt nucleo-f429zi smoltcp-phy' ARGS="--release --target=thumbv7em-none-eabihf --example=ip"
+      env: FEATURES='stm32f429 smoltcp-phy smoltcp-log smoltcp-verbose' ARGS="--release --target=thumbv7em-none-eabihf --example=ip"
 script:
   - "cargo build --target=`uname -m`-unknown-linux-gnu --no-default-features --features \"$FEATURES\""

Cargo.toml

@@ -4,7 +4,7 @@ name = "stm32-eth"
 description = "Embedded Rust Ethernet driver for the STM32 MCU series"
 license = "Apache-2.0"
 authors = ["Astro <[email protected]>"]
-version = "0.1.2"
+version = "0.2.0"
 keywords = ["ethernet", "eth", "stm32", "stm32f4"]
 repository = "https://github.com/stm32-rs/stm32-eth"
 documentation = "https://docs.rs/stm32-eth/"
@@ -15,32 +15,44 @@ travis-ci = { repository = "astro/stm32-eth", branch = "master" }
 maintenance = { status = "experimental" }
 
 [package.metadata.docs.rs]
-features = [ "smoltcp-phy", "nucleo-f429zi" ]
+features = [ "smoltcp-phy", "stm32f429" ]
 
 [dependencies]
 volatile-register = "0.2"
 aligned = "0.3"
-stm32f4xx-hal = "0.7"
+stm32f4xx-hal = "0.8.3"
 
-smoltcp = { version = "0.6.0", default-features = false, features = ["proto-ipv4", "proto-ipv6", "socket-icmp", "socket-udp", "socket-tcp", "log", "verbose", "ethernet"], optional = true }
+smoltcp = { version = "0.6.0", default-features = false, features = ["proto-ipv4", "proto-ipv6", "socket-icmp", "socket-udp", "socket-tcp", "ethernet"], optional = true }
 log = { version = "0.4", optional = true }
 
 [features]
-smoltcp-phy = ["smoltcp", "log"]
-default = []
-nucleo-f429zi = ["stm32f4xx-hal/stm32f429"]
+device-selected = []
+stm32f407 = ["stm32f4xx-hal/stm32f407", "device-selected"]
+stm32f417 = ["stm32f4xx-hal/stm32f417", "device-selected"]
+stm32f427 = ["stm32f4xx-hal/stm32f427", "device-selected"]
+stm32f429 = ["stm32f4xx-hal/stm32f429", "device-selected"]
+stm32f437 = ["stm32f4xx-hal/stm32f437", "device-selected"]
+stm32f439 = ["stm32f4xx-hal/stm32f439", "device-selected"]
+stm32f469 = ["stm32f4xx-hal/stm32f469", "device-selected"]
+stm32f479 = ["stm32f4xx-hal/stm32f479", "device-selected"]
+smoltcp-phy = ["smoltcp"]
+smoltcp-log = ["log", "smoltcp/log"]
+smoltcp-verbose = ["smoltcp/verbose"]
 
 [dev-dependencies]
-cortex-m = "0.5"
+cortex-m = "0.6.2"
 cortex-m-rt = "0.6"
 panic-itm = "0.4"
+cortex-m-semihosting = "0.3.5"
+stm32f4xx-hal = {version = "0.8.3", features = ["rt"] }
 
 [[example]]
 name = "pktgen"
+required-features = ["stm32f429"]
 
 [[example]]
 name = "ip"
-required-features = ["smoltcp-phy"]
+required-features = ["stm32f429", "smoltcp-phy", "smoltcp-log", "smoltcp-verbose"]
 
 [profile.release]
 debug = 2

README.md

@@ -13,8 +13,8 @@ Please send pull requests.
 
 Add to the `[dependencies]` section in your `Cargo.toml`:
 ```rust
-stm32f4xx-hal = { version = "*", features = ["stm32f429"] }
-stm32-eth = { version = "0.1.1", features = ["nucleo-f429zi"] }
+stm32f4xx-hal = { version = "0.8.3", features = ["stm32f429"] }
+stm32-eth = { version = "0.2.0", features = ["stm32f429"] }
 ```
 
 In `src/main.rs` add:
@@ -28,33 +28,45 @@ use stm32_eth::{Eth, RingEntry};
 fn main() {
     let p = Peripherals::take().unwrap();
 
-    // Setup pins and initialize clocks.
-    stm32_eth::setup(&p.RCC, &p.SYSCFG);
+    let rcc = p.RCC.constrain();
+    // HCLK must be between 25MHz and 168MHz to use the ethernet peripheral
+    let clocks = rcc.cfgr.sysclk(32.mhz()).hclk(32.mhz()).freeze();
+
     let gpioa = p.GPIOA.split();
     let gpiob = p.GPIOB.split();
     let gpioc = p.GPIOC.split();
     let gpiog = p.GPIOG.split();
-    stm32_eth::setup_pins(
-        gpioa.pa1, gpioa.pa2, gpioa.pa7, gpiob.pb13, gpioc.pc1,
-        gpioc.pc4, gpioc.pc5, gpiog.pg11, gpiog.pg13
-    );
-    // Allocate the ring buffers
-    let mut rx_ring: [RingEntry<_>; 8] = Default::default();
-    let mut tx_ring: [RingEntry<_>; 2] = Default::default();
-    // Instantiate driver
-    let mut eth = Eth::new(
-        p.ETHERNET_MAC, p.ETHERNET_DMA,
-        &mut rx_ring[..], &mut tx_ring[..]
-    );
-    // If you have a handler, enable interrupts
-    eth.enable_interrupt(&mut cp.NVIC);
 
+    let eth_pins = EthPins {
+        ref_clk: gpioa.pa1,
+        md_io: gpioa.pa2,
+        md_clk: gpioc.pc1,
+        crs: gpioa.pa7,
+        tx_en: gpiog.pg11,
+        tx_d0: gpiog.pg13,
+        tx_d1: gpiob.pb13,
+        rx_d0: gpioc.pc4,
+        rx_d1: gpioc.pc5,
+    };
+
+    let mut rx_ring: [RingEntry<_>; 16] = Default::default();
+    let mut tx_ring: [RingEntry<_>; 8] = Default::default();
+    let mut eth = Eth::new(
+        p.ETHERNET_MAC,
+        p.ETHERNET_DMA,
+        &mut rx_ring[..],
+        &mut tx_ring[..],
+        PhyAddress::_0,
+        clocks,
+        eth_pins,
+    )
+    .unwrap();
+    eth.enable_interrupt();
 
     if let Ok(pkt) = eth.recv_next() {
         // handle received pkt
     }
 
-
     eth.send(size, |buf| {
         // write up to `size` bytes into buf before it is being sent
     }).expect("send");

examples/ip.rs

@@ -7,6 +7,7 @@ use cortex_m::asm;
 use cortex_m_rt::{entry, exception};
 use stm32f4xx_hal::{
     gpio::GpioExt,
+    prelude::*,
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
@@ -22,7 +23,7 @@ use smoltcp::socket::{SocketSet, TcpSocket, TcpSocketBuffer};
 use smoltcp::time::Instant;
 use smoltcp::wire::{EthernetAddress, IpAddress, IpCidr, Ipv4Address};
 
-use stm32_eth::{Eth, RingEntry};
+use stm32_eth::{Eth, EthPins, PhyAddress, RingEntry};
 
 static mut LOGGER: HioLogger = HioLogger {};
 
@@ -59,18 +60,29 @@ fn main() -> ! {
     let p = Peripherals::take().unwrap();
     let mut cp = CorePeripherals::take().unwrap();
 
+    let rcc = p.RCC.constrain();
+    // HCLK must be between 25MHz and 168MHz to use the ethernet peripheral
+    let clocks = rcc.cfgr.sysclk(32.mhz()).hclk(32.mhz()).freeze();
+
     setup_systick(&mut cp.SYST);
 
     writeln!(stdout, "Enabling ethernet...").unwrap();
-    stm32_eth::setup(&p.RCC, &p.SYSCFG);
     let gpioa = p.GPIOA.split();
     let gpiob = p.GPIOB.split();
     let gpioc = p.GPIOC.split();
     let gpiog = p.GPIOG.split();
-    stm32_eth::setup_pins(
-        gpioa.pa1, gpioa.pa2, gpioa.pa7, gpiob.pb13, gpioc.pc1, gpioc.pc4, gpioc.pc5, gpiog.pg11,
-        gpiog.pg13,
-    );
+
+    let eth_pins = EthPins {
+        ref_clk: gpioa.pa1,
+        md_io: gpioa.pa2,
+        md_clk: gpioc.pc1,
+        crs: gpioa.pa7,
+        tx_en: gpiog.pg11,
+        tx_d0: gpiog.pg13,
+        tx_d1: gpiob.pb13,
+        rx_d0: gpioc.pc4,
+        rx_d1: gpioc.pc5,
+    };
 
     let mut rx_ring: [RingEntry<_>; 8] = Default::default();
     let mut tx_ring: [RingEntry<_>; 2] = Default::default();
@@ -79,8 +91,12 @@ fn main() -> ! {
         p.ETHERNET_DMA,
         &mut rx_ring[..],
         &mut tx_ring[..],
-    );
-    eth.enable_interrupt(&mut cp.NVIC);
+        PhyAddress::_0,
+        clocks,
+        eth_pins,
+    )
+    .unwrap();
+    eth.enable_interrupt();
 
     let local_addr = Ipv4Address::new(10, 0, 0, 1);
     let ip_addr = IpCidr::new(IpAddress::from(local_addr), 24);

examples/pktgen.rs

@@ -11,13 +11,14 @@ use cortex_m::asm;
 use cortex_m::interrupt::Mutex;
 use stm32f4xx_hal::{
     gpio::GpioExt,
+    prelude::*,
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
 use core::fmt::Write;
 use cortex_m_semihosting::hio;
 
-use stm32_eth::{Eth, RingEntry, TxError};
+use stm32_eth::{Eth, EthPins, PhyAddress, RingEntry, TxError};
 
 const SRC_MAC: [u8; 6] = [0x00, 0x00, 0xDE, 0xAD, 0xBE, 0xEF];
 const DST_MAC: [u8; 6] = [0x00, 0x00, 0xBE, 0xEF, 0xDE, 0xAD];
@@ -33,18 +34,29 @@ fn main() -> ! {
     let p = Peripherals::take().unwrap();
     let mut cp = CorePeripherals::take().unwrap();
 
+    let rcc = p.RCC.constrain();
+    // HCLK must be between 25MHz and 168MHz to use the ethernet peripheral
+    let clocks = rcc.cfgr.sysclk(32.mhz()).hclk(32.mhz()).freeze();
+
     setup_systick(&mut cp.SYST);
 
     writeln!(stdout, "Enabling ethernet...").unwrap();
-    stm32_eth::setup(&p.RCC, &p.SYSCFG);
     let gpioa = p.GPIOA.split();
     let gpiob = p.GPIOB.split();
     let gpioc = p.GPIOC.split();
     let gpiog = p.GPIOG.split();
-    stm32_eth::setup_pins(
-        gpioa.pa1, gpioa.pa2, gpioa.pa7, gpiob.pb13, gpioc.pc1, gpioc.pc4, gpioc.pc5, gpiog.pg11,
-        gpiog.pg13,
-    );
+
+    let eth_pins = EthPins {
+        ref_clk: gpioa.pa1,
+        md_io: gpioa.pa2,
+        md_clk: gpioc.pc1,
+        crs: gpioa.pa7,
+        tx_en: gpiog.pg11,
+        tx_d0: gpiog.pg13,
+        tx_d1: gpiob.pb13,
+        rx_d0: gpioc.pc4,
+        rx_d1: gpioc.pc5,
+    };
 
     let mut rx_ring: [RingEntry<_>; 16] = Default::default();
     let mut tx_ring: [RingEntry<_>; 8] = Default::default();
@@ -53,8 +65,12 @@ fn main() -> ! {
         p.ETHERNET_DMA,
         &mut rx_ring[..],
         &mut tx_ring[..],
-    );
-    eth.enable_interrupt(&mut cp.NVIC);
+        PhyAddress::_0,
+        clocks,
+        eth_pins,
+    )
+    .unwrap();
+    eth.enable_interrupt();
 
     // Main loop
     let mut last_stats_time = 0usize;

run.sh

@@ -13,7 +13,7 @@ if [[ "$EXAMPLE" = "" ]]; then
 fi
 
 cargo build --target=thumbv7em-none-eabihf --release \
-      --features="stm32f4xx-hal/rt nucleo-f429zi smoltcp-phy" \
+      --features="stm32f429 smoltcp-phy smoltcp-log smoltcp-verbose" \
       --example=$EXAMPLE \
     || exit 1
 

src/desc.rs

@@ -11,7 +11,7 @@ pub struct Descriptor {
 impl Clone for Descriptor {
     fn clone(&self) -> Self {
         Descriptor {
-            desc: Aligned((*self.desc).clone()),
+            desc: Aligned(*self.desc),
         }
     }
 }