Merge pull request #3 from quartiq/release/0.3.0

Prepping for release

.github/workflows/ci.yml

@@ -0,0 +1,117 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [master]
+
+  pull_request:
+    branches: [master]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt
+
+      - name: Style Check
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+  clippy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          target: thumbv7em-none-eabihf
+          override: true
+          components: clippy
+
+      - name: Clippy Check
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --all-features
+
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          target: thumbv7em-none-eabihf
+          override: true
+
+      - name: Cargo Doc
+        uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: --all-features
+
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cargo Audit
+        uses: actions-rs/audit-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  compile:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toolchain:
+          - stable
+          - beta
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Rust ${{ matrix.toolchain }}
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          target: thumbv7em-none-eabihf
+          override: true
+
+      - name: Cargo Check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --verbose --all-features
+
+      - name: Cargo Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --all-features
+
+      - name: Cargo Build [Release]
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --release --all-features
+
+      - name: Cargo Build [Examples]
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --examples --all-features

Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 categories = ["embedded", "no-std"]
 name = "enc424j600"
-description = "Embbeded Rust Ethernet driver for ENC424J600 Ethernet controller with SPI interface, compatible with STM32F4xx"
+description = "Embbeded Rust Ethernet driver for ENC424J600 Ethernet controller with SPI interface"
-authors = ["Harry Ho <hh@m-labs.hk>"]
+authors = ["Harry Ho <hh@m-labs.hk>", "Dip Cheung <dc@m-labs.hk>"]
-version = "0.2.0"
+version = "0.3.0"
 keywords = ["ethernet", "eth", "enc424j600", "stm32", "stm32f4xx"]
 repository = "https://git.m-labs.hk/M-Labs/ENC424J600"
 edition = "2018"
@@ -13,33 +13,30 @@ license = "BSD-2-Clause"
 volatile-register = "0.2"
 aligned = "0.3"
 embedded-hal = "0.2"
-smoltcp = { version = "0.7.0", default-features = false, features = ["proto-ipv4", "proto-ipv6", "socket-icmp", "socket-udp", "socket-tcp", "log", "verbose", "ethernet"], optional = true }
+smoltcp = { version = "0.7.0", default-features = false, features = [ "socket-raw", "proto-ipv4",
+    "proto-ipv6", "socket-tcp", "ethernet"], optional = true }
+cortex-m = {version = "0.5", optional = true }
+
 # Optional dependencies for building examples
-stm32f4xx-hal = { version = "0.8", optional = true }
+[dev-dependencies]
-cortex-m = { version = "0.5", optional = true }
+stm32f4xx-hal = { version = "0.8", features = ["stm32f407", "rt"] }
-cortex-m-rt = { version = "0.6", optional = true }
+cortex-m-rt = "0.6"
-cortex-m-rtic = { version = "0.5.3", optional = true }
+cortex-m-rtic = "0.5.3"
-panic-itm = { version = "0.4", optional = true }
+panic-itm = "0.4"
-log = { version = "0.4", optional = true }
+log = "0.4"
 
 [features]
 smoltcp-phy = ["smoltcp"]
-smoltcp-phy-all = [
+cortex-m-cpu = ["cortex-m"]
-    "smoltcp/socket-raw", "smoltcp/socket-udp", "smoltcp/socket-tcp",
-    "smoltcp/proto-ipv4", "smoltcp/proto-ipv6"
-]
-# Example-based features
-tx_stm32f407 = ["stm32f4xx-hal/stm32f407", "cortex-m", "cortex-m-rtic", "panic-itm", "log"]
-tcp_stm32f407 = ["stm32f4xx-hal/stm32f407", "cortex-m", "cortex-m-rt", "cortex-m-rtic", "smoltcp-phy-all", "smoltcp/log", "panic-itm", "log"]
 default = []
 
 [[example]]
 name = "tx_stm32f407"
-required-features = ["tx_stm32f407"]
+required-features = ["smoltcp", "cortex-m-cpu"]
 
 [[example]]
 name = "tcp_stm32f407"
-required-features = ["tcp_stm32f407"]
+required-features = ["smoltcp", "cortex-m-cpu"]
 
 [profile.release]
 codegen-units = 1

examples/tcp_stm32f407.rs

@@ -2,43 +2,31 @@
 #![no_main]
 
 extern crate panic_itm;
-use cortex_m::{iprintln, iprint};
+use cortex_m::{iprint, iprintln};
 
-use embedded_hal::{
+use embedded_hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
-    digital::v2::OutputPin,
+use enc424j600::smoltcp_phy;
-    blocking::delay::DelayMs
-};
 use stm32f4xx_hal::{
-    rcc::RccExt,
+    delay::Delay, gpio::GpioExt, rcc::RccExt, spi::Spi, stm32::ITM, time::Hertz, time::U32Ext,
-    gpio::GpioExt,
-    time::U32Ext,
-    stm32::ITM,
-    delay::Delay,
-    spi::Spi,
-    time::Hertz
 };
-use enc424j600;
-use enc424j600::{smoltcp_phy, EthController};
 
-use smoltcp::wire::{
-    EthernetAddress, IpAddress, IpCidr, Ipv6Cidr
-};
-use smoltcp::iface::{NeighborCache, EthernetInterfaceBuilder, EthernetInterface};
-use smoltcp::socket::{SocketSet, TcpSocket, TcpSocketBuffer};
-use core::str;
 use core::fmt::Write;
+use core::str;
+use smoltcp::iface::{EthernetInterface, EthernetInterfaceBuilder, NeighborCache};
+use smoltcp::socket::{SocketSet, TcpSocket, TcpSocketBuffer};
+use smoltcp::wire::{EthernetAddress, IpAddress, IpCidr, Ipv6Cidr};
 
 /// Timer
 use core::cell::RefCell;
 use cortex_m::interrupt::Mutex;
 use cortex_m_rt::exception;
+use smoltcp::time::Instant;
 use stm32f4xx_hal::{
     rcc::Clocks,
+    stm32::SYST,
     time::MilliSeconds,
-    timer::{Timer, Event as TimerEvent},
+    timer::{Event as TimerEvent, Timer},
-    stm32::SYST
 };
-use smoltcp::time::Instant;
 /// Rate in Hz
 const TIMER_RATE: u32 = 20;
 /// Interval duration in milliseconds
@@ -56,32 +44,34 @@ fn timer_setup(syst: SYST, clocks: Clocks) {
 #[exception]
 fn SysTick() {
     cortex_m::interrupt::free(|cs| {
-        *TIMER_MS.borrow(cs)
+        *TIMER_MS.borrow(cs).borrow_mut() += TIMER_DELTA;
-            .borrow_mut() += TIMER_DELTA;
     });
 }
 
 /// Obtain current time in milliseconds
 pub fn timer_now() -> MilliSeconds {
-    let ms = cortex_m::interrupt::free(|cs| {
+    let ms = cortex_m::interrupt::free(|cs| *TIMER_MS.borrow(cs).borrow());
-        *TIMER_MS.borrow(cs)
-            .borrow()
-    });
     ms.ms()
 }
 
 ///
 use stm32f4xx_hal::{
-    stm32::SPI1,
     gpio::{
-        gpioa::{PA5, PA6, PA7, PA4},
+        gpioa::{PA4, PA5, PA6, PA7},
-        Alternate, AF5, Output, PushPull
+        Alternate, Output, PushPull, AF5,
-    }
+    },
+    stm32::SPI1,
 };
-type BoosterSpiEth = enc424j600::SpiEth<
+type SpiEth = enc424j600::Enc424j600<
-    Spi<SPI1, (PA5<Alternate<AF5>>, PA6<Alternate<AF5>>, PA7<Alternate<AF5>>)>,
+    Spi<
+        SPI1,
+        (
+            PA5<Alternate<AF5>>,
+            PA6<Alternate<AF5>>,
+            PA7<Alternate<AF5>>,
+        ),
+    >,
     PA4<Output<PushPull>>,
-    fn(u32) -> ()
 >;
 
 pub struct NetStorage {
@@ -91,19 +81,15 @@ pub struct NetStorage {
 
 static mut NET_STORE: NetStorage = NetStorage {
     // Placeholder for the real IP address, which is initialized at runtime.
-    ip_addrs: [IpCidr::Ipv6(
+    ip_addrs: [IpCidr::Ipv6(Ipv6Cidr::SOLICITED_NODE_PREFIX)],
-        Ipv6Cidr::SOLICITED_NODE_PREFIX,
-    )],
     neighbor_cache: [None; 8],
 };
 
 #[rtic::app(device = stm32f4xx_hal::stm32, peripherals = true, monotonic = rtic::cyccnt::CYCCNT)]
 const APP: () = {
     struct Resources {
-        eth_iface: EthernetInterface<
+        eth_iface: EthernetInterface<'static, smoltcp_phy::SmoltcpDevice<SpiEth>>,
-            'static,
+        itm: ITM,
-            smoltcp_phy::SmoltcpDevice<BoosterSpiEth>>,
-        itm: ITM
     }
 
     #[init()]
@@ -115,7 +101,10 @@ const APP: () = {
         c.core.DWT.enable_cycle_counter();
         c.core.DCB.enable_trace();
 
-        let clocks = c.device.RCC.constrain()
+        let clocks = c
+            .device
+            .RCC
+            .constrain()
             .cfgr
             .sysclk(168.mhz())
             .hclk(168.mhz())
@@ -128,8 +117,7 @@ const APP: () = {
         let mut itm = c.core.ITM;
         let stim0 = &mut itm.stim[0];
 
-        iprintln!(stim0,
+        iprintln!(stim0, "Eth TCP Server on STM32-F407 via NIC100/ENC424J600");
-            "Eth TCP Server on STM32-F407 via NIC100/ENC424J600");
 
         // NIC100 / ENC424J600 Set-up
         let spi1 = c.device.SPI1;
@@ -149,19 +137,18 @@ const APP: () = {
         let eth_iface = {
             let mut spi_eth = {
                 let spi_eth_port = Spi::spi1(
-                    spi1, (spi1_sck, spi1_miso, spi1_mosi),
+                    spi1,
+                    (spi1_sck, spi1_miso, spi1_mosi),
                     enc424j600::spi::interfaces::SPI_MODE,
                     Hertz(enc424j600::spi::interfaces::SPI_CLOCK_FREQ),
-                    clocks);
+                    clocks,
+                );
 
-                let delay_ns_fp: fn(u32) -> () = |time_ns| {
+                SpiEth::new(spi_eth_port, spi1_nss).cpu_freq_mhz(168)
-                    cortex_m::asm::delay((time_ns*21)/125 + 1)
-                };
-                enc424j600::SpiEth::new(spi_eth_port, spi1_nss, delay_ns_fp)
             };
 
             // Init controller
-            match spi_eth.init_dev() {
+            match spi_eth.reset(&mut delay) {
                 Ok(_) => {
                     iprintln!(stim0, "Initializing Ethernet...")
                 }
@@ -172,14 +159,14 @@ const APP: () = {
 
             // Read MAC
             let mut eth_mac_addr: [u8; 6] = [0; 6];
-            spi_eth.read_from_mac(&mut eth_mac_addr);
+            spi_eth.read_mac_addr(&mut eth_mac_addr);
             for i in 0..6 {
                 let byte = eth_mac_addr[i];
                 match i {
                     0 => iprint!(stim0, "MAC Address = {:02x}-", byte),
                     1..=4 => iprint!(stim0, "{:02x}-", byte),
                     5 => iprint!(stim0, "{:02x}\n", byte),
-                _ => ()
+                    _ => (),
                 };
             }
 
@@ -212,10 +199,7 @@ const APP: () = {
         timer_setup(delay.free(), clocks);
         iprintln!(stim0, "Timer initialized");
 
-        init::LateResources {
+        init::LateResources { eth_iface, itm }
-            eth_iface,
-            itm
-        }
     }
 
     #[idle(resources=[eth_iface, itm])]
@@ -245,8 +229,11 @@ const APP: () = {
         let greet_handle = socket_set.add(greet_socket);
         {
             let store = unsafe { &mut NET_STORE };
-            iprintln!(stim0,
+            iprintln!(
-                "TCP sockets will listen at {}", store.ip_addrs[0].address());
+                stim0,
+                "TCP sockets will listen at {}",
+                store.ip_addrs[0].address()
+            );
         }
 
         // Copied / modified from:
@@ -258,8 +245,7 @@ const APP: () = {
             let now = timer_now().0;
             let instant = Instant::from_millis(now as i64);
             match iface.poll(&mut socket_set, instant) {
-                Ok(_) => {
+                Ok(_) => {}
-                },
                 Err(e) => {
                     iprintln!(stim0, "[{}] Poll error: {:?}", instant, e)
                 }
@@ -268,33 +254,40 @@ const APP: () = {
             {
                 let mut socket = socket_set.get::<TcpSocket>(echo_handle);
                 if !socket.is_open() {
-                    iprintln!(stim0,
+                    iprintln!(
-                        "[{}] Listening to port 1234 for echoing, time-out in 10s", instant);
+                        stim0,
+                        "[{}] Listening to port 1234 for echoing, time-out in 10s",
+                        instant
+                    );
                     socket.listen(1234).unwrap();
                     socket.set_timeout(Some(smoltcp::time::Duration::from_millis(10000)));
                 }
                 if socket.can_recv() {
-                    iprintln!(stim0,
+                    iprintln!(
-                    "[{}] Received packet: {:?}", instant, socket.recv(|buffer| {
+                        stim0,
-                        (buffer.len(), str::from_utf8(buffer).unwrap())
+                        "[{}] Received packet: {:?}",
-                    }));
+                        instant,
+                        socket.recv(|buffer| { (buffer.len(), str::from_utf8(buffer).unwrap()) })
+                    );
                 }
             }
             // Control the "greeting" socket (:4321)
             {
                 let mut socket = socket_set.get::<TcpSocket>(greet_handle);
                 if !socket.is_open() {
-                    iprintln!(stim0,
+                    iprintln!(
+                        stim0,
                         "[{}] Listening to port 4321 for greeting, \
-                        please connect to the port", instant);
+                        please connect to the port",
+                        instant
+                    );
                     socket.listen(4321).unwrap();
                 }
 
                 if socket.can_send() {
                     let greeting = "Welcome to the server demo for STM32-F407!";
                     write!(socket, "{}\n", greeting).unwrap();
-                    iprintln!(stim0,
+                    iprintln!(stim0, "[{}] Greeting sent, socket closed", instant);
-                        "[{}] Greeting sent, socket closed", instant);
                     socket.close();
                 }
             }

examples/tx_stm32f407.rs

@@ -2,41 +2,38 @@
 #![no_main]
 
 extern crate panic_itm;
-use cortex_m::{iprintln, iprint};
+use cortex_m::{iprint, iprintln};
 
-use embedded_hal::{
+use embedded_hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
-    digital::v2::OutputPin,
+use enc424j600::EthPhy;
-    blocking::delay::DelayMs
-};
 use stm32f4xx_hal::{
-    rcc::RccExt,
+    delay::Delay, gpio::GpioExt, rcc::RccExt, spi::Spi, stm32::ITM, time::Hertz, time::U32Ext,
-    gpio::GpioExt,
-    time::U32Ext,
-    stm32::ITM,
-    delay::Delay,
-    spi::Spi,
-    time::Hertz
 };
-use enc424j600;
-use enc424j600::EthController;
 
 ///
 use stm32f4xx_hal::{
-    stm32::SPI1,
     gpio::{
-        gpioa::{PA5, PA6, PA7, PA4},
+        gpioa::{PA4, PA5, PA6, PA7},
-        Alternate, AF5, Output, PushPull
+        Alternate, Output, PushPull, AF5,
     },
+    stm32::SPI1,
 };
-type BoosterSpiEth = enc424j600::SpiEth<
+type SpiEth = enc424j600::Enc424j600<
-    Spi<SPI1, (PA5<Alternate<AF5>>, PA6<Alternate<AF5>>, PA7<Alternate<AF5>>)>,
+    Spi<
+        SPI1,
+        (
+            PA5<Alternate<AF5>>,
+            PA6<Alternate<AF5>>,
+            PA7<Alternate<AF5>>,
+        ),
+    >,
     PA4<Output<PushPull>>,
-    fn(u32)>;
+>;
 
 #[rtic::app(device = stm32f4xx_hal::stm32, peripherals = true, monotonic = rtic::cyccnt::CYCCNT)]
 const APP: () = {
     struct Resources {
-        spi_eth: BoosterSpiEth,
+        spi_eth: SpiEth,
         delay: Delay,
         itm: ITM,
     }
@@ -46,7 +43,10 @@ const APP: () = {
         c.core.SCB.enable_icache();
         c.core.SCB.enable_dcache(&mut c.core.CPUID);
 
-        let clocks = c.device.RCC.constrain()
+        let clocks = c
+            .device
+            .RCC
+            .constrain()
             .cfgr
             .sysclk(168.mhz())
             .hclk(168.mhz())
@@ -60,8 +60,7 @@ const APP: () = {
         // Init ITM
         let mut itm = c.core.ITM;
         let stim0 = &mut itm.stim[0];
-        iprintln!(stim0,
+        iprintln!(stim0, "Eth TX Pinging on STM32-F407 via NIC100/ENC424J600");
-            "Eth TX Pinging on STM32-F407 via NIC100/ENC424J600");
 
         // NIC100 / ENC424J600 Set-up
         let spi1 = c.device.SPI1;
@@ -79,19 +78,18 @@ const APP: () = {
         // Create SPI1 for HAL
         let mut spi_eth = {
             let spi_eth_port = Spi::spi1(
-                spi1, (spi1_sck, spi1_miso, spi1_mosi),
+                spi1,
+                (spi1_sck, spi1_miso, spi1_mosi),
                 enc424j600::spi::interfaces::SPI_MODE,
                 Hertz(enc424j600::spi::interfaces::SPI_CLOCK_FREQ),
-                clocks);
+                clocks,
+            );
 
-            let delay_ns: fn(u32) -> () = |time_ns| {
+            SpiEth::new(spi_eth_port, spi1_nss).cpu_freq_mhz(168)
-                cortex_m::asm::delay((time_ns*21)/125 + 1)
-            };
-            enc424j600::SpiEth::new(spi_eth_port, spi1_nss, delay_ns)
         };
 
         // Init
-        match spi_eth.init_dev() {
+        match spi_eth.reset(&mut delay) {
             Ok(_) => {
                 iprintln!(stim0, "Initializing Ethernet...")
             }
@@ -102,14 +100,14 @@ const APP: () = {
 
         // Read MAC
         let mut eth_mac_addr: [u8; 6] = [0; 6];
-        spi_eth.read_from_mac(&mut eth_mac_addr);
+        spi_eth.read_mac_addr(&mut eth_mac_addr);
         for i in 0..6 {
             let byte = eth_mac_addr[i];
             match i {
                 0 => iprint!(stim0, "MAC Address = {:02x}-", byte),
                 1..=4 => iprint!(stim0, "{:02x}-", byte),
                 5 => iprint!(stim0, "{:02x}\n", byte),
-                _ => ()
+                _ => (),
             };
         }
 
@@ -130,20 +128,20 @@ const APP: () = {
         let stim0 = &mut c.resources.itm.stim[0];
         // Testing Eth TX
         let eth_tx_dat: [u8; 64] = [
-            0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x08, 0x60,
+            0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x08, 0x60, 0x6e, 0x44, 0x42, 0x95, 0x08, 0x06,
-            0x6e, 0x44, 0x42, 0x95, 0x08, 0x06, 0x00, 0x01,
+            0x00, 0x01, 0x08, 0x00, 0x06, 0x04, 0x00, 0x01, 0x08, 0x60, 0x6e, 0x44, 0x42, 0x95,
-            0x08, 0x00, 0x06, 0x04, 0x00, 0x01, 0x08, 0x60,
+            0xc0, 0xa8, 0x01, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xa8, 0x01, 0xe7,
-            0x6e, 0x44, 0x42, 0x95, 0xc0, 0xa8, 0x01, 0x64,
+            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xa8,
+            0x00, 0x00, 0x00, 0x00, 0x69, 0xd0, 0x85, 0x9f,
-            0x01, 0xe7, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-            0x00, 0x00, 0x00, 0x00, 0x69, 0xd0, 0x85, 0x9f
         ];
         loop {
             let mut eth_tx_packet = enc424j600::tx::TxPacket::new();
             eth_tx_packet.update_frame(&eth_tx_dat, 64);
-            iprint!(stim0,
+            iprint!(
-                "Sending packet (len={:}): ", eth_tx_packet.get_frame_length());
+                stim0,
+                "Sending packet (len={:}): ",
+                eth_tx_packet.get_frame_length()
+            );
             for i in 0..20 {
                 let byte = eth_tx_packet.get_frame_byte(i);
                 match i {
@@ -154,10 +152,10 @@ const APP: () = {
                     13..=14 | 16..=18 => iprint!(stim0, "{:02x}", byte),
                     5 | 11 | 15 => iprint!(stim0, "{:02x} ", byte),
                     19 => iprint!(stim0, "{:02x} ...\n", byte),
-                    _ => ()
+                    _ => (),
                 };
             }
-            c.resources.spi_eth.send_raw_packet(&eth_tx_packet);
+            c.resources.spi_eth.send_packet(&eth_tx_packet);
             iprintln!(stim0, "Packet sent");
             c.resources.delay.delay_ms(100_u32);
         }

nix/itm-tools.nix

@@ -1,21 +0,0 @@
-{ stdenv, fetchFromGitHub, rustPlatform, pkg-config }:
-
-rustPlatform.buildRustPackage rec {
-  version = "2019-11-15";
-  pname = "itm-tools";
-
-  src = fetchFromGitHub {
-    owner = "japaric";
-    repo = "itm-tools";
-    rev = "e94155e44019d893ac8e6dab51cc282d344ab700";
-    sha256 = "19xkjym0i7y52cfhvis49c59nzvgw4906cd8bkz8ka38mbgfqgiy";
-  };
-
-  cargoPatches = [ ./itm-tools-cargo-lock.patch ];
-
-  cargoSha256 = "0is702s14pgvd5i2m8aaw3zcsshqrwj97mjgg3wikbc627pagzg7";
-
-  nativeBuildInputs = [ pkg-config ];
-
-  doCheck = false;
-}

nix/rustPlatform.nix

@@ -10,7 +10,7 @@ let
   ];
   rustChannel =
     lib.rustLib.fromManifestFile rustManifest {
-      inherit stdenv fetchurl patchelf;
+      inherit stdenv lib fetchurl patchelf;
     };
   rust =
     rustChannel.rust.override {

shell.nix

@@ -8,8 +8,6 @@ with pkgs;
 let
   rustPlatform = callPackage ./nix/rustPlatform.nix {};
 
-  itm-tools = callPackage ./nix/itm-tools.nix { inherit rustPlatform; };
-
   runHelp = writeShellScriptBin "run-help" ''
     echo "[Common Tools]"
     echo "  run-openocd-f4x"
@@ -103,7 +101,7 @@ in
 stdenv.mkDerivation {
   name = "enc424j600-stm32-env";
   buildInputs = with rustPlatform.rust; [
-    rustc cargo pkgs.gdb pkgs.openocd pkgs.tmux itm-tools 
+    rustc cargo pkgs.gdb pkgs.openocd pkgs.tmux pkgs.itm-tools 
     runHelp runTmuxEnv killTmuxEnv
     runOpenOcdF4x runItmDemuxFollow
     exTxStm32f407 exTcpStm32f407

src/lib.rs

@@ -2,134 +2,175 @@
 
 pub mod spi;
 use embedded_hal::{
-    blocking::{
+    blocking::{delay::DelayUs, spi::Transfer},
-        spi::Transfer,
-    },
     digital::v2::OutputPin,
 };
 
 pub mod rx;
 pub mod tx;
 
-#[cfg(feature="smoltcp")]
+#[cfg(feature = "smoltcp")]
 pub mod smoltcp_phy;
 
 /// Max raw frame array size
 pub const RAW_FRAME_LENGTH_MAX: usize = 1518;
 
-pub trait EthController {
+/// Trait representing PHY layer of ENC424J600
-    fn init_dev(&mut self) -> Result<(), EthControllerError>;
+pub trait EthPhy {
-    fn init_rxbuf(&mut self) -> Result<(), EthControllerError>;
+    fn recv_packet(&mut self, is_poll: bool) -> Result<rx::RxPacket, Error>;
-    fn init_txbuf(&mut self) -> Result<(), EthControllerError>;
+    fn send_packet(&mut self, packet: &tx::TxPacket) -> Result<(), Error>;
-    fn receive_next(&mut self, is_poll: bool) -> Result<rx::RxPacket, EthControllerError>;
-    fn send_raw_packet(&mut self, packet: &tx::TxPacket) -> Result<(), EthControllerError>;
-    fn set_promiscuous(&mut self) -> Result<(), EthControllerError>;
-    fn read_from_mac(&mut self, mac: &mut [u8]) -> Result<(), EthControllerError>;
-    fn write_mac_address(&mut self, mac: &[u8]) -> Result<(), EthControllerError>;
 }
 
 /// TODO: Improve these error types
 #[derive(Debug)]
-pub enum EthControllerError {
+pub enum Error {
     SpiPortError,
-    GeneralError,
+    RegisterError,
     // TODO: Better name?
-    NoRxPacketError
+    NoRxPacketError,
 }
 
-impl From<spi::SpiPortError> for EthControllerError {
+impl From<spi::Error> for Error {
-    fn from(_: spi::SpiPortError) -> EthControllerError {
+    fn from(_: spi::Error) -> Error {
-        EthControllerError::SpiPortError
+        Error::SpiPortError
     }
 }
 
-/// Ethernet controller using SPI interface
+/// ENC424J600 controller in SPI mode
-pub struct SpiEth<SPI: Transfer<u8>,
+pub struct Enc424j600<SPI: Transfer<u8>, NSS: OutputPin> {
-                  NSS: OutputPin,
+    spi_port: spi::SpiPort<SPI, NSS>,
-                  F: FnMut(u32) -> ()> {
-    spi_port: spi::SpiPort<SPI, NSS, F>,
     rx_buf: rx::RxBuffer,
-    tx_buf: tx::TxBuffer
+    tx_buf: tx::TxBuffer,
 }
 
-impl <SPI: Transfer<u8>,
+impl<SPI: Transfer<u8>, NSS: OutputPin> Enc424j600<SPI, NSS> {
-      NSS: OutputPin,
+    pub fn new(spi: SPI, nss: NSS) -> Self {
-      F: FnMut(u32) -> ()> SpiEth<SPI, NSS, F> {
+        Enc424j600 {
-    pub fn new(spi: SPI, nss: NSS, delay_ns: F) -> Self {
+            spi_port: spi::SpiPort::new(spi, nss),
-        SpiEth {
-            spi_port: spi::SpiPort::new(spi, nss, delay_ns),
             rx_buf: rx::RxBuffer::new(),
-            tx_buf: tx::TxBuffer::new()
+            tx_buf: tx::TxBuffer::new(),
         }
     }
-}
 
-impl <SPI: Transfer<u8>,
+    #[cfg(feature = "cortex-m-cpu")]
-      NSS: OutputPin,
+    pub fn cpu_freq_mhz(mut self, freq: u32) -> Self {
-      F: FnMut(u32) -> ()> EthController for SpiEth<SPI, NSS, F> {
+        self.spi_port = self.spi_port.cpu_freq_mhz(freq);
-    fn init_dev(&mut self) -> Result<(), EthControllerError> {
+        self
+    }
+
+    pub fn init(&mut self, delay: &mut impl DelayUs<u16>) -> Result<(), Error> {
+        self.reset(delay)?;
+        self.init_rxbuf()?;
+        self.init_txbuf()?;
+        Ok(())
+    }
+
+    pub fn reset(&mut self, delay: &mut impl DelayUs<u16>) -> Result<(), Error> {
         // Write 0x1234 to EUDAST
         self.spi_port.write_reg_16b(spi::addrs::EUDAST, 0x1234)?;
         // Verify that EUDAST is 0x1234
         let mut eudast = self.spi_port.read_reg_16b(spi::addrs::EUDAST)?;
         if eudast != 0x1234 {
-            return Err(EthControllerError::GeneralError)
+            return Err(Error::RegisterError);
         }
         // Poll CLKRDY (ESTAT<12>) to check if it is set
         loop {
             let estat = self.spi_port.read_reg_16b(spi::addrs::ESTAT)?;
-            if estat & 0x1000 == 0x1000 { break }
+            if estat & 0x1000 == 0x1000 {
+                break;
+            }
         }
-        // Set ETHRST (ECON2<4>) to 1
+        // Issue system reset - set ETHRST (ECON2<4>) to 1
-        let econ2 = self.spi_port.read_reg_8b(spi::addrs::ECON2)?;
+        self.spi_port.send_opcode(spi::opcodes::SETETHRST)?;
-        self.spi_port.write_reg_8b(spi::addrs::ECON2, 0x10 | (econ2 & 0b11101111))?;
+        delay.delay_us(25);
-        self.spi_port.delay_us(25);
         // Verify that EUDAST is 0x0000
         eudast = self.spi_port.read_reg_16b(spi::addrs::EUDAST)?;
         if eudast != 0x0000 {
-            return Err(EthControllerError::GeneralError)
+            return Err(Error::RegisterError);
         }
-        self.spi_port.delay_us(256);
+        delay.delay_us(256);
         Ok(())
     }
 
-    fn init_rxbuf(&mut self) -> Result<(), EthControllerError> {
+    pub fn init_rxbuf(&mut self) -> Result<(), Error> {
         // Set ERXST pointer
-        self.spi_port.write_reg_16b(spi::addrs::ERXST, self.rx_buf.get_wrap_addr())?;
+        self.spi_port
+            .write_reg_16b(spi::addrs::ERXST, self.rx_buf.get_start_addr())?;
         // Set ERXTAIL pointer
-        self.spi_port.write_reg_16b(spi::addrs::ERXTAIL, self.rx_buf.get_tail_addr())?;
+        self.spi_port
+            .write_reg_16b(spi::addrs::ERXTAIL, self.rx_buf.get_tail_addr())?;
         // Set MAMXFL to maximum number of bytes in each accepted packet
-        self.spi_port.write_reg_16b(spi::addrs::MAMXFL, RAW_FRAME_LENGTH_MAX as u16)?;
+        self.spi_port
-        // Enable RXEN (ECON1<0>)
+            .write_reg_16b(spi::addrs::MAMXFL, RAW_FRAME_LENGTH_MAX as u16)?;
-        let econ1 = self.spi_port.read_reg_16b(spi::addrs::ECON1)?;
+        // Enable RX - set RXEN (ECON1<0>) to 1
-        self.spi_port.write_reg_16b(spi::addrs::ECON1, 0x1 | (econ1 & 0xfffe))?;
+        self.spi_port.send_opcode(spi::opcodes::ENABLERX)?;
         Ok(())
     }
 
-    fn init_txbuf(&mut self) -> Result<(), EthControllerError> {
+    pub fn init_txbuf(&mut self) -> Result<(), Error> {
         // Set EGPWRPT pointer
         self.spi_port.write_reg_16b(spi::addrs::EGPWRPT, 0x0000)?;
         Ok(())
     }
 
+    /// Set controller to Promiscuous Mode
+    pub fn set_promiscuous(&mut self) -> Result<(), Error> {
+        // From Section 10.12, ENC424J600 Data Sheet:
+        // "To accept all incoming frames regardless of content (Promiscuous mode),
+        // set the CRCEN, RUNTEN, UCEN, NOTMEEN and MCEN bits."
+        let erxfcon_lo = self.spi_port.read_reg_8b(spi::addrs::ERXFCON)?;
+        self.spi_port.write_reg_8b(
+            spi::addrs::ERXFCON,
+            0b0101_1110 | (erxfcon_lo & 0b1010_0001),
+        )?;
+        Ok(())
+    }
+
+    /// Read MAC to [u8; 6]
+    pub fn read_mac_addr(&mut self, mac: &mut [u8]) -> Result<(), Error> {
+        mac[0] = self.spi_port.read_reg_8b(spi::addrs::MAADR1)?;
+        mac[1] = self.spi_port.read_reg_8b(spi::addrs::MAADR1 + 1)?;
+        mac[2] = self.spi_port.read_reg_8b(spi::addrs::MAADR2)?;
+        mac[3] = self.spi_port.read_reg_8b(spi::addrs::MAADR2 + 1)?;
+        mac[4] = self.spi_port.read_reg_8b(spi::addrs::MAADR3)?;
+        mac[5] = self.spi_port.read_reg_8b(spi::addrs::MAADR3 + 1)?;
+        Ok(())
+    }
+
+    pub fn write_mac_addr(&mut self, mac: &[u8]) -> Result<(), Error> {
+        self.spi_port.write_reg_8b(spi::addrs::MAADR1, mac[0])?;
+        self.spi_port.write_reg_8b(spi::addrs::MAADR1 + 1, mac[1])?;
+        self.spi_port.write_reg_8b(spi::addrs::MAADR2, mac[2])?;
+        self.spi_port.write_reg_8b(spi::addrs::MAADR2 + 1, mac[3])?;
+        self.spi_port.write_reg_8b(spi::addrs::MAADR3, mac[4])?;
+        self.spi_port.write_reg_8b(spi::addrs::MAADR3 + 1, mac[5])?;
+        Ok(())
+    }
+}
+
+impl<SPI: Transfer<u8>, NSS: OutputPin> EthPhy for Enc424j600<SPI, NSS> {
     /// Receive the next packet and return it
     /// Set is_poll to true for returning until PKTIF is set;
     /// Set is_poll to false for returning Err when PKTIF is not set
-    fn receive_next(&mut self, is_poll: bool) -> Result<rx::RxPacket, EthControllerError> {
+    fn recv_packet(&mut self, is_poll: bool) -> Result<rx::RxPacket, Error> {
         // Poll PKTIF (EIR<4>) to check if it is set
         loop {
             let eir = self.spi_port.read_reg_16b(spi::addrs::EIR)?;
-            if eir & 0x40 == 0x40 { break }
+            if eir & 0x40 == 0x40 {
+                break;
+            }
             if !is_poll {
-                return Err(EthControllerError::NoRxPacketError)
+                return Err(Error::NoRxPacketError);
             }
         }
         // Set ERXRDPT pointer to next_addr
-        self.spi_port.write_reg_16b(spi::addrs::ERXRDPT, self.rx_buf.get_next_addr())?;
+        self.spi_port
+            .write_reg_16b(spi::addrs::ERXRDPT, self.rx_buf.get_next_addr())?;
         // Read 2 bytes to update next_addr
         let mut next_addr_buf = [0; 3];
         self.spi_port.read_rxdat(&mut next_addr_buf, 2)?;
-        self.rx_buf.set_next_addr((next_addr_buf[1] as u16) | ((next_addr_buf[2] as u16) << 8));
+        self.rx_buf
+            .set_next_addr((next_addr_buf[1] as u16) | ((next_addr_buf[2] as u16) << 8));
         // Read 6 bytes to update rsv
         let mut rsv_buf = [0; 7];
         self.spi_port.read_rxdat(&mut rsv_buf, 6)?;
@@ -141,78 +182,61 @@ impl <SPI: Transfer<u8>,
         rx_packet.update_frame_length();
         // Read frame bytes
         let mut frame_buf = [0; RAW_FRAME_LENGTH_MAX];
-        self.spi_port.read_rxdat(&mut frame_buf, rx_packet.get_frame_length())?;
+        self.spi_port
+            .read_rxdat(&mut frame_buf, rx_packet.get_frame_length())?;
         rx_packet.copy_frame_from(&frame_buf[1..]);
         // Set ERXTAIL pointer to (next_addr - 2)
-        if self.rx_buf.get_next_addr() > rx::ERXST_DEFAULT {
+        // * Assume head, tail, next and wrap addresses are word-aligned (even)
-            self.spi_port.write_reg_16b(spi::addrs::ERXTAIL, self.rx_buf.get_next_addr() - 2)?;
+        // - If next_addr is at least (start_addr+2), then set tail pointer to the word right before next_addr
+        if self.rx_buf.get_next_addr() > self.rx_buf.get_start_addr() {
+            self.spi_port
+                .write_reg_16b(spi::addrs::ERXTAIL, self.rx_buf.get_next_addr() - 2)?;
+        // - Otherwise, next_addr will wrap, so set tail pointer to the last word address of RX buffer
         } else {
-            self.spi_port.write_reg_16b(spi::addrs::ERXTAIL, rx::RX_MAX_ADDRESS - 1)?;
+            self.spi_port
+                .write_reg_16b(spi::addrs::ERXTAIL, rx::RX_MAX_ADDRESS - 1)?;
         }
-        // Set PKTDEC (ECON1<88>) to decrement PKTCNT
+        // Decrement PKTCNT - set PKTDEC (ECON1<8>)
-        let econ1_hi = self.spi_port.read_reg_8b(spi::addrs::ECON1 + 1)?;
+        self.spi_port.send_opcode(spi::opcodes::SETPKTDEC)?;
-        self.spi_port.write_reg_8b(spi::addrs::ECON1 + 1, 0x01 | (econ1_hi & 0xfe))?;
         // Return the RxPacket
         Ok(rx_packet)
     }
 
     /// Send an established packet
-    fn send_raw_packet(&mut self, packet: &tx::TxPacket) -> Result<(), EthControllerError> {
+    fn send_packet(&mut self, packet: &tx::TxPacket) -> Result<(), Error> {
         // Set EGPWRPT pointer to next_addr
-        self.spi_port.write_reg_16b(spi::addrs::EGPWRPT, self.tx_buf.get_next_addr())?;
+        self.spi_port
+            .write_reg_16b(spi::addrs::EGPWRPT, self.tx_buf.get_next_addr())?;
         // Copy packet data to SRAM Buffer
         // 1-byte Opcode is included
         let mut txdat_buf: [u8; RAW_FRAME_LENGTH_MAX + 1] = [0; RAW_FRAME_LENGTH_MAX + 1];
         packet.write_frame_to(&mut txdat_buf[1..]);
-        self.spi_port.write_txdat(&mut txdat_buf, packet.get_frame_length())?;
+        self.spi_port
+            .write_txdat(&mut txdat_buf, packet.get_frame_length())?;
         // Set ETXST to packet start address
-        self.spi_port.write_reg_16b(spi::addrs::ETXST, self.tx_buf.get_next_addr())?;
+        self.spi_port
+            .write_reg_16b(spi::addrs::ETXST, self.tx_buf.get_next_addr())?;
         // Set ETXLEN to packet length
-        self.spi_port.write_reg_16b(spi::addrs::ETXLEN, packet.get_frame_length() as u16)?;
+        self.spi_port
-        // Set TXRTS (ECON1<1>) to start transmission
+            .write_reg_16b(spi::addrs::ETXLEN, packet.get_frame_length() as u16)?;
-        let mut econ1_lo = self.spi_port.read_reg_8b(spi::addrs::ECON1)?;
+        // Send packet - set TXRTS (ECON1<1>) to start transmission
-        self.spi_port.write_reg_8b(spi::addrs::ECON1, 0x02 | (econ1_lo & 0xfd))?;
+        self.spi_port.send_opcode(spi::opcodes::SETTXRTS)?;
         // Poll TXRTS (ECON1<1>) to check if it is reset
         loop {
-            econ1_lo = self.spi_port.read_reg_8b(spi::addrs::ECON1)?;
+            let econ1_lo = self.spi_port.read_reg_8b(spi::addrs::ECON1)?;
-            if econ1_lo & 0x02 == 0 { break }
+            if econ1_lo & 0x02 == 0 {
+                break;
+            }
         }
         // TODO: Read ETXSTAT to understand Ethernet transmission status
         // (See: Register 9-2, ENC424J600 Data Sheet)
         // Update TX buffer start address
-        self.tx_buf.set_next_addr((self.tx_buf.get_next_addr() + packet.get_frame_length() as u16) %
+        // * Assume TX buffer consumes the entire general-purpose SRAM block
-            tx::GPBUFEN_DEFAULT);
+        self.tx_buf.set_next_addr(
-        Ok(())
+            (self.tx_buf.get_next_addr() + packet.get_frame_length() as u16)
-    }
+                % self.rx_buf.get_start_addr()
-
+                - self.tx_buf.get_start_addr(),
-    /// Set controller to Promiscuous Mode
+        );
-    fn set_promiscuous(&mut self) -> Result<(), EthControllerError> {
-        // From Section 10.12, ENC424J600 Data Sheet:
-        // "To accept all incoming frames regardless of content (Promiscuous mode),
-        // set the CRCEN, RUNTEN, UCEN, NOTMEEN and MCEN bits."
-        let erxfcon_lo = self.spi_port.read_reg_8b(spi::addrs::ERXFCON)?;
-        self.spi_port.write_reg_8b(spi::addrs::ERXFCON, 0b0101_1110 | (erxfcon_lo & 0b1010_0001))?;
-        Ok(())
-    }
-
-    /// Read MAC to [u8; 6]
-    fn read_from_mac(&mut self, mac: &mut [u8]) -> Result<(), EthControllerError> {
-        mac[0] = self.spi_port.read_reg_8b(spi::addrs::MAADR1)?;
-        mac[1] = self.spi_port.read_reg_8b(spi::addrs::MAADR1 + 1)?;
-        mac[2] = self.spi_port.read_reg_8b(spi::addrs::MAADR2)?;
-        mac[3] = self.spi_port.read_reg_8b(spi::addrs::MAADR2 + 1)?;
-        mac[4] = self.spi_port.read_reg_8b(spi::addrs::MAADR3)?;
-        mac[5] = self.spi_port.read_reg_8b(spi::addrs::MAADR3 + 1)?;
-        Ok(())
-    }
-
-    fn write_mac_address(&mut self, mac: &[u8]) -> Result<(), EthControllerError> {
-        self.spi_port.write_reg_8b(spi::addrs::MAADR1, mac[0])?;
-        self.spi_port.write_reg_8b(spi::addrs::MAADR1 + 1, mac[1])?;
-        self.spi_port.write_reg_8b(spi::addrs::MAADR2, mac[2])?;
-        self.spi_port.write_reg_8b(spi::addrs::MAADR2 + 1, mac[3])?;
-        self.spi_port.write_reg_8b(spi::addrs::MAADR3, mac[4])?;
-        self.spi_port.write_reg_8b(spi::addrs::MAADR3 + 1, mac[5])?;
         Ok(())
     }
 }

src/rx.rs

@@ -11,38 +11,38 @@ pub const RSV_LENGTH: usize = 6;
 /// Struct for RX Buffer on the hardware
 /// TODO: Should be a singleton
 pub struct RxBuffer {
-    wrap_addr: u16,
+    start_addr: u16,
     next_addr: u16,
-    tail_addr: u16
+    tail_addr: u16,
 }
 
 impl RxBuffer {
     pub fn new() -> Self {
         RxBuffer {
-            wrap_addr: ERXST_DEFAULT,
+            start_addr: ERXST_DEFAULT,
             next_addr: ERXST_DEFAULT,
-            tail_addr: ERXTAIL_DEFAULT
+            tail_addr: ERXTAIL_DEFAULT,
         }
     }
 
-    pub fn set_wrap_addr(&mut self, addr: u16) {
+    pub fn set_start_addr(&mut self, addr: u16) {
-        self.wrap_addr = addr;
+        self.start_addr = addr;
     }
-    pub fn get_wrap_addr(& self) -> u16{
+    pub fn get_start_addr(&self) -> u16 {
-        self.wrap_addr
+        self.start_addr
     }
 
     pub fn set_next_addr(&mut self, addr: u16) {
         self.next_addr = addr;
     }
-    pub fn get_next_addr(& self) -> u16{
+    pub fn get_next_addr(&self) -> u16 {
         self.next_addr
     }
 
     pub fn set_tail_addr(&mut self, addr: u16) {
         self.tail_addr = addr;
     }
-    pub fn get_tail_addr(& self) -> u16{
+    pub fn get_tail_addr(&self) -> u16 {
         self.tail_addr
     }
 }
@@ -52,7 +52,7 @@ impl RxBuffer {
 pub struct RxPacket {
     rsv: Rsv,
     frame: [u8; RAW_FRAME_LENGTH_MAX],
-    frame_length: usize
+    frame_length: usize,
 }
 
 impl RxPacket {
@@ -60,7 +60,7 @@ impl RxPacket {
         RxPacket {
             rsv: Rsv::new(),
             frame: [0; RAW_FRAME_LENGTH_MAX],
-            frame_length: 0
+            frame_length: 0,
         }
     }
 
@@ -106,14 +106,14 @@ impl RxPacket {
 struct Rsv {
     raw_rsv: [u8; RSV_LENGTH],
     // TODO: Add more definitions
-    frame_length: u16
+    frame_length: u16,
 }
 
 impl Rsv {
     fn new() -> Self {
         Rsv {
             raw_rsv: [0; RSV_LENGTH],
-            frame_length: 0_u16
+            frame_length: 0_u16,
         }
     }
 
@@ -132,4 +132,4 @@ impl Rsv {
     fn get_frame_length(&self) -> u16 {
         self.frame_length
     }
-}
+}

src/smoltcp_phy.rs

@@ -1,32 +1,30 @@
-use crate::{
+use crate::{tx, EthPhy, RAW_FRAME_LENGTH_MAX};
-    EthController, tx, RAW_FRAME_LENGTH_MAX
-};
 use core::cell;
 use smoltcp::{
     phy::{Device, DeviceCapabilities, RxToken, TxToken},
     time::Instant,
-    Error
+    Error,
 };
 
-pub struct SmoltcpDevice<EC: EthController> {
+pub struct SmoltcpDevice<E: EthPhy> {
-    pub eth_controller: cell::RefCell<EC>,
+    pub eth_phy: cell::RefCell<E>,
     rx_packet_buf: [u8; RAW_FRAME_LENGTH_MAX],
-    tx_packet_buf: [u8; RAW_FRAME_LENGTH_MAX]
+    tx_packet_buf: [u8; RAW_FRAME_LENGTH_MAX],
 }
 
-impl<EC: EthController> SmoltcpDevice<EC> {
+impl<E: EthPhy> SmoltcpDevice<E> {
-    pub fn new(eth_controller: EC) -> Self {
+    pub fn new(eth_phy: E) -> Self {
         SmoltcpDevice {
-            eth_controller: cell::RefCell::new(eth_controller),
+            eth_phy: cell::RefCell::new(eth_phy),
             rx_packet_buf: [0; RAW_FRAME_LENGTH_MAX],
-            tx_packet_buf: [0; RAW_FRAME_LENGTH_MAX]
+            tx_packet_buf: [0; RAW_FRAME_LENGTH_MAX],
         }
     }
 }
 
-impl<'a, EC: 'a + EthController> Device<'a> for SmoltcpDevice<EC> {
+impl<'a, E: 'a + EthPhy> Device<'a> for SmoltcpDevice<E> {
     type RxToken = EthRxToken<'a>;
-    type TxToken = EthTxToken<'a, EC>;
+    type TxToken = EthTxToken<'a, E>;
 
     fn capabilities(&self) -> DeviceCapabilities {
         let mut caps = DeviceCapabilities::default();
@@ -35,33 +33,33 @@ impl<'a, EC: 'a + EthController> Device<'a> for SmoltcpDevice<EC> {
     }
 
     fn receive(&'a mut self) -> Option<(Self::RxToken, Self::TxToken)> {
-        let self_p = (&mut *self) as *mut SmoltcpDevice<EC>;
+        let self_p = (&mut *self) as *mut SmoltcpDevice<E>;
-        match self.eth_controller.borrow_mut().receive_next(false) {
+        match self.eth_phy.borrow_mut().recv_packet(false) {
             Ok(rx_packet) => {
                 // Write received packet to RX packet buffer
                 rx_packet.write_frame_to(&mut self.rx_packet_buf);
                 // Construct a RxToken
                 let rx_token = EthRxToken {
                     buf: &mut self.rx_packet_buf,
-                    len: rx_packet.get_frame_length()
+                    len: rx_packet.get_frame_length(),
                 };
                 // Construct a blank TxToken
                 let tx_token = EthTxToken {
                     buf: &mut self.tx_packet_buf,
-                    dev: self_p
+                    dev: self_p,
                 };
                 Some((rx_token, tx_token))
-            },
+            }
-            Err(_) => None
+            Err(_) => None,
         }
     }
 
     fn transmit(&'a mut self) -> Option<Self::TxToken> {
-        let self_p = (&mut *self) as *mut SmoltcpDevice<EC>;
+        let self_p = (&mut *self) as *mut SmoltcpDevice<E>;
         // Construct a blank TxToken
         let tx_token = EthTxToken {
             buf: &mut self.tx_packet_buf,
-            dev: self_p
+            dev: self_p,
         };
         Some(tx_token)
     }
@@ -69,7 +67,7 @@ impl<'a, EC: 'a + EthController> Device<'a> for SmoltcpDevice<EC> {
 
 pub struct EthRxToken<'a> {
     buf: &'a mut [u8],
-    len: usize
+    len: usize,
 }
 
 impl<'a> RxToken for EthRxToken<'a> {
@@ -81,12 +79,12 @@ impl<'a> RxToken for EthRxToken<'a> {
     }
 }
 
-pub struct EthTxToken<'a, EC: EthController> {
+pub struct EthTxToken<'a, E: EthPhy> {
     buf: &'a mut [u8],
-    dev: *mut SmoltcpDevice<EC>
+    dev: *mut SmoltcpDevice<E>,
 }
 
-impl<'a, EC: 'a + EthController> TxToken for EthTxToken<'a, EC> {
+impl<'a, E: 'a + EthPhy> TxToken for EthTxToken<'a, E> {
     fn consume<R, F>(self, _timestamp: Instant, len: usize, f: F) -> Result<R, Error>
     where
         F: FnOnce(&mut [u8]) -> Result<R, Error>,
@@ -97,12 +95,10 @@ impl<'a, EC: 'a + EthController> TxToken for EthTxToken<'a, EC> {
         // Update frame length and write frame bytes
         tx_packet.update_frame(&mut self.buf[..len], len);
         // Send the packet as raw
-        let eth_controller = unsafe {
+        let eth_phy = unsafe { &mut (*self.dev).eth_phy };
-            &mut (*self.dev).eth_controller
+        match eth_phy.borrow_mut().send_packet(&tx_packet) {
-        };
+            Ok(_) => result,
-        match eth_controller.borrow_mut().send_raw_packet(&tx_packet) {
+            Err(_) => Err(Error::Exhausted),
-            Ok(_) => { result },
-            Err(_) => Err(Error::Exhausted)
         }
     }
 }

src/spi.rs

@@ -1,7 +1,4 @@
-use embedded_hal::{
+use embedded_hal::{blocking::spi::Transfer, digital::v2::OutputPin};
-    blocking::spi::Transfer,
-    digital::v2::OutputPin,
-};
 
 pub mod interfaces {
     use embedded_hal::spi;
@@ -15,193 +12,206 @@ pub mod interfaces {
 }
 
 pub mod opcodes {
-    /// SPI Opcodes
+    /// 1-byte Instructions
+    pub const SETETHRST: u8 = 0b1100_1010;
+    pub const SETPKTDEC: u8 = 0b1100_1100;
+    pub const SETTXRTS: u8 = 0b1101_0100;
+    pub const ENABLERX: u8 = 0b1110_1000;
+    /// 3-byte Instructions
+    pub const WRXRDPT: u8 = 0b0110_0100; // 8-bit opcode followed by data
+    pub const RRXRDPT: u8 = 0b0110_0110; // 8-bit opcode followed by data
+    pub const WGPWRPT: u8 = 0b0110_1100; // 8-bit opcode followed by data
+    pub const RGPWRPT: u8 = 0b0110_1110; // 8-bit opcode followed by data
+    /// N-byte Instructions
     pub const RCRU: u8 = 0b0010_0000;
     pub const WCRU: u8 = 0b0010_0010;
-    pub const RERXDATA: u8 = 0b0010_1100;   // 8-bit opcode followed by data
+    pub const RRXDATA: u8 = 0b0010_1100; // 8-bit opcode followed by data
-    pub const WEGPDATA: u8 = 0b0010_1010;   // 8-bit opcode followed by data
+    pub const WGPDATA: u8 = 0b0010_1010; // 8-bit opcode followed by data
 }
 
 pub mod addrs {
     /// SPI Register Mapping
     /// Note: PSP interface use different address mapping
     // SPI Init Reset Registers
-    pub const EUDAST: u8 = 0x16;        // 16-bit data
+    pub const EUDAST: u8 = 0x16; // 16-bit data
-    pub const ESTAT: u8 = 0x1a;         // 16-bit data
+    pub const ESTAT: u8 = 0x1a; // 16-bit data
-    pub const ECON2: u8 = 0x6e;         // 16-bit data
+    pub const ECON2: u8 = 0x6e; // 16-bit data
-    //
+                                //
-    pub const ERXFCON: u8 = 0x34;       // 16-bit data
+    pub const ERXFCON: u8 = 0x34; // 16-bit data
-    //
+                                  //
-    pub const MAADR3: u8 = 0x60;        // 16-bit data
+    pub const MAADR3: u8 = 0x60; // 16-bit data
-    pub const MAADR2: u8 = 0x62;        // 16-bit data
+    pub const MAADR2: u8 = 0x62; // 16-bit data
-    pub const MAADR1: u8 = 0x64;        // 16-bit data
+    pub const MAADR1: u8 = 0x64; // 16-bit data
-    // RX Registers
+                                 // RX Registers
-    pub const ERXRDPT: u8 = 0x8a;       // 16-bit data
+    pub const ERXRDPT: u8 = 0x8a; // 16-bit data
-    pub const ERXST: u8 = 0x04;         // 16-bit data
+    pub const ERXST: u8 = 0x04; // 16-bit data
-    pub const ERXTAIL: u8 = 0x06;       // 16-bit data
+    pub const ERXTAIL: u8 = 0x06; // 16-bit data
-    pub const EIR: u8 = 0x1c;           // 16-bit data
+    pub const EIR: u8 = 0x1c; // 16-bit data
-    pub const ECON1: u8 = 0x1e;         // 16-bit data
+    pub const ECON1: u8 = 0x1e; // 16-bit data
-    pub const MAMXFL: u8 = 0x4a;        // 16-bit data
+    pub const MAMXFL: u8 = 0x4a; // 16-bit data
-    // TX Registers
+                                 // TX Registers
-    pub const EGPWRPT: u8 = 0x88;       // 16-bit data
+    pub const EGPWRPT: u8 = 0x88; // 16-bit data
-    pub const ETXST: u8 = 0x00;         // 16-bit data
+    pub const ETXST: u8 = 0x00; // 16-bit data
-    pub const ETXSTAT: u8 = 0x12;       // 16-bit data
+    pub const ETXSTAT: u8 = 0x12; // 16-bit data
-    pub const ETXLEN: u8 = 0x02;        // 16-bit data
+    pub const ETXLEN: u8 = 0x02; // 16-bit data
 }
 
 /// Struct for SPI I/O interface on ENC424J600
 /// Note: stm32f4xx_hal::spi's pins include: SCK, MISO, MOSI
-pub struct SpiPort<SPI: Transfer<u8>,
+pub struct SpiPort<SPI: Transfer<u8>, NSS: OutputPin> {
-                   NSS: OutputPin,
-                   F: FnMut(u32) -> ()> {
     spi: SPI,
     nss: NSS,
-    delay_ns: F,
+    #[cfg(feature = "cortex-m-cpu")]
+    cpu_freq_mhz: f32,
 }
 
-pub enum SpiPortError {
+pub enum Error {
-    TransferError
+    OpcodeError,
+    TransferError,
 }
 
 #[allow(unused_must_use)]
-impl <SPI: Transfer<u8>,
+impl<SPI: Transfer<u8>, NSS: OutputPin> SpiPort<SPI, NSS> {
-      NSS: OutputPin,
-      F: FnMut(u32) -> ()> SpiPort<SPI, NSS, F> {
     // TODO: return as Result()
-    pub fn new(spi: SPI, mut nss: NSS, delay_ns: F) -> Self {
+    pub fn new(spi: SPI, mut nss: NSS) -> Self {
         nss.set_high();
 
         SpiPort {
             spi,
             nss,
-            delay_ns,
+            #[cfg(feature = "cortex-m-cpu")]
+            cpu_freq_mhz: 0.,
         }
     }
 
-    pub fn read_reg_8b(&mut self, addr: u8) -> Result<u8, SpiPortError> {
+    #[cfg(feature = "cortex-m-cpu")]
-        // Using RCRU instruction to read using unbanked (full) address
+    pub fn cpu_freq_mhz(mut self, freq: u32) -> Self {
-        let r_data = self.rw_addr_u8(opcodes::RCRU, addr, 0)?;
+        self.cpu_freq_mhz = freq as f32;
-        Ok(r_data)
+        self
     }
 
-    pub fn read_reg_16b(&mut self, lo_addr: u8) -> Result<u16, SpiPortError> {
+    pub fn read_reg_8b(&mut self, addr: u8) -> Result<u8, Error> {
-        let r_data_lo = self.read_reg_8b(lo_addr)?;
+        // Using RCRU instruction to read using unbanked (full) address
-        let r_data_hi = self.read_reg_8b(lo_addr + 1)?;
+        let mut buf: [u8; 4] = [0; 4];
-        // Combine top and bottom 8-bit to return 16-bit
+        buf[1] = addr;
-        Ok(((r_data_hi as u16) << 8) | r_data_lo as u16)
+        self.rw_n(&mut buf, opcodes::RCRU, 2)?;
+        Ok(buf[2])
+    }
+
+    pub fn read_reg_16b(&mut self, lo_addr: u8) -> Result<u16, Error> {
+        // Unless the register can be written with specific opcode,
+        // use WCRU instruction to write using unbanked (full) address
+        let mut buf: [u8; 4] = [0; 4];
+        let mut data_offset = 0; // number of bytes separating
+                                 // actual data from opcode
+        match lo_addr {
+            addrs::ERXRDPT | addrs::EGPWRPT => {}
+            _ => {
+                buf[1] = lo_addr;
+                data_offset = 1;
+            }
+        }
+        self.rw_n(
+            &mut buf,
+            match lo_addr {
+                addrs::ERXRDPT => opcodes::RRXRDPT,
+                addrs::EGPWRPT => opcodes::RGPWRPT,
+                _ => opcodes::RCRU,
+            },
+            2 + data_offset, // extra 8-bit lo_addr before data
+        )?;
+        Ok(buf[data_offset + 1] as u16 | (buf[data_offset + 2] as u16) << 8)
     }
 
     // Currently requires manual slicing (buf[1..]) for the data read back
-    pub fn read_rxdat<'a>(&mut self, buf: &'a mut [u8], data_length: usize)
+    pub fn read_rxdat<'a>(&mut self, buf: &'a mut [u8], data_length: usize) -> Result<(), Error> {
-                         -> Result<(), SpiPortError> {
+        self.rw_n(buf, opcodes::RRXDATA, data_length)
-        let r_valid = self.r_n(buf, opcodes::RERXDATA, data_length)?;
-        Ok(r_valid)
     }
 
-    // Currenly requires actual data to be stored in buf[1..] instead of buf[0..]
+    // Currently requires actual data to be stored in buf[1..] instead of buf[0..]
     // TODO: Maybe better naming?
-    pub fn write_txdat<'a>(&mut self, buf: &'a mut [u8], data_length: usize)
+    pub fn write_txdat<'a>(&mut self, buf: &'a mut [u8], data_length: usize) -> Result<(), Error> {
-                          -> Result<(), SpiPortError> {
+        self.rw_n(buf, opcodes::WGPDATA, data_length)
-        let w_valid = self.w_n(buf, opcodes::WEGPDATA, data_length)?;
-        Ok(w_valid)
     }
 
-    pub fn write_reg_8b(&mut self, addr: u8, data: u8) -> Result<(), SpiPortError> {
+    pub fn write_reg_8b(&mut self, addr: u8, data: u8) -> Result<(), Error> {
-        // TODO: addr should be separated from w_data
         // Using WCRU instruction to write using unbanked (full) address
-        self.rw_addr_u8(opcodes::WCRU, addr, data)?;
-        Ok(())
-    }
-
-    pub fn write_reg_16b(&mut self, lo_addr: u8, data: u16) -> Result<(), SpiPortError> {
-        self.write_reg_8b(lo_addr, (data & 0xff) as u8)?;
-        self.write_reg_8b(lo_addr + 1, ((data & 0xff00) >> 8) as u8)?;
-        Ok(())
-    }
-
-    pub fn delay_us(&mut self, duration: u32) {
-        (self.delay_ns)(duration * 1000)
-    }
-
-    // TODO: Generalise transfer functions
-    // TODO: (Make data read/write as reference to array)
-    // Currently requires 1-byte addr, read/write data is only 1-byte
-    fn rw_addr_u8(&mut self, opcode: u8, addr: u8, data: u8)
-                 -> Result<u8, SpiPortError> {
-        // Enable chip select
-        self.nss.set_low();
-        // Start writing to SLAVE
-        // TODO: don't just use 3 bytes
         let mut buf: [u8; 3] = [0; 3];
-        buf[0] = opcode;
         buf[1] = addr;
         buf[2] = data;
-        match self.spi.transfer(&mut buf) {
+        self.rw_n(&mut buf, opcodes::WCRU, 2)
-            Ok(_) => {
+    }
-                // Disable chip select
+
-                (self.delay_ns)(60);
+    pub fn write_reg_16b(&mut self, lo_addr: u8, data: u16) -> Result<(), Error> {
-                self.nss.set_high();
+        // Unless the register can be written with specific opcode,
-                (self.delay_ns)(30);
+        // use WCRU instruction to write using unbanked (full) address
-                Ok(buf[2])
+        let mut buf: [u8; 4] = [0; 4];
-            },
+        let mut data_offset = 0; // number of bytes separating
-            // TODO: Maybe too naive?
+                                 // actual data from opcode
-            Err(_) => {
+        match lo_addr {
-                // Disable chip select
+            addrs::ERXRDPT | addrs::EGPWRPT => {}
-                (self.delay_ns)(60);
+            _ => {
-                self.nss.set_high();
+                buf[1] = lo_addr;
-                (self.delay_ns)(30);
+                data_offset = 1;
-                Err(SpiPortError::TransferError)
             }
         }
+        buf[1 + data_offset] = data as u8;
+        buf[2 + data_offset] = (data >> 8) as u8;
+        self.rw_n(
+            &mut buf,
+            match lo_addr {
+                addrs::ERXRDPT => opcodes::WRXRDPT,
+                addrs::EGPWRPT => opcodes::WGPWRPT,
+                _ => opcodes::WCRU,
+            },
+            2 + data_offset, // extra 8-bit lo_addr before data
+        )
+    }
+
+    pub fn send_opcode(&mut self, opcode: u8) -> Result<(), Error> {
+        match opcode {
+            opcodes::SETETHRST | opcodes::SETPKTDEC | opcodes::SETTXRTS | opcodes::ENABLERX => {
+                let mut buf: [u8; 1] = [0];
+                self.rw_n(&mut buf, opcode, 0)
+            }
+            _ => Err(Error::OpcodeError),
+        }
     }
 
-    // TODO: Generalise transfer functions
-    // Currently does NOT accept addr, read data is N-byte long
-    // Returns a reference to the data returned
-    // Note: buf must be at least (data_length + 1)-byte long
-    // TODO: Check and raise error for array size < (data_length + 1)
-    fn r_n<'a>(&mut self, buf: &'a mut [u8], opcode: u8, data_length: usize)
-              -> Result<(), SpiPortError> {
-        // Enable chip select
-        self.nss.set_low();
-        // Start writing to SLAVE
-        buf[0] = opcode;
-        match self.spi.transfer(&mut buf[..data_length+1]) {
-            Ok(_) => {
-                // Disable chip select
-                self.nss.set_high();
-                Ok(())
-            },
-            // TODO: Maybe too naive?
-            Err(_) => {
-                // Disable chip select
-                self.nss.set_high();
-                Err(SpiPortError::TransferError)
-            }
-        }
-    }
-
-    // Note: buf[0] is currently reserved for opcode to overwrite
     // TODO: Actual data should start from buf[0], not buf[1]
-    fn w_n<'a>(&mut self, buf: &'a mut [u8], opcode: u8, data_length: usize)
+    // Completes an SPI transfer for reading data to the given buffer,
-              -> Result<(), SpiPortError> {
+    // or writing data from the buffer.
+    // It sends an 8-bit instruction, followed by either
+    // receiving or sending n*8-bit data.
+    // The slice of buffer provided must begin with the 8-bit instruction.
+    // If n = 0, the transfer will only involve sending the instruction.
+    fn rw_n<'a>(&mut self, buf: &'a mut [u8], opcode: u8, data_length: usize) -> Result<(), Error> {
+        assert!(buf.len() > data_length);
         // Enable chip select
         self.nss.set_low();
+        // >=50ns min. CS_n setup time
+        #[cfg(feature = "cortex-m-cpu")]
+        cortex_m::asm::delay((0.05 * (self.cpu_freq_mhz + 1.)) as u32);
         // Start writing to SLAVE
         buf[0] = opcode;
-        // TODO: Maybe need to copy data to buf later on
+        let result = self.spi.transfer(&mut buf[..data_length + 1]);
-        match self.spi.transfer(&mut buf[..data_length+1]) {
+        match opcode {
-            Ok(_) => {
+            opcodes::RCRU | opcodes::WCRU | opcodes::RRXDATA | opcodes::WGPDATA => {
                 // Disable chip select
+                // >=50ns min. CS_n hold time
+                #[cfg(feature = "cortex-m-cpu")]
+                cortex_m::asm::delay((0.05 * (self.cpu_freq_mhz + 1.)) as u32);
                 self.nss.set_high();
-                Ok(())
+                // >=20ns min. CS_n disable time
-            },
+                #[cfg(feature = "cortex-m-cpu")]
-            // TODO: Maybe too naive?
+                cortex_m::asm::delay((0.02 * (self.cpu_freq_mhz + 1.)) as u32);
-            Err(_) => {
-                // Disable chip select
-                self.nss.set_high();
-                Err(SpiPortError::TransferError)
             }
+            _ => {}
+        }
+        match result {
+            Ok(_) => Ok(()),
+            // TODO: Maybe too naive?
+            Err(_) => Err(Error::TransferError),
         }
     }
-}
+}

src/tx.rs

@@ -1,45 +1,41 @@
 use crate::RAW_FRAME_LENGTH_MAX;
 
-/// SRAM Addresses
-pub const GPBUFST_DEFAULT: u16 = 0x0000;    // Start of General-Purpose SRAM Buffer
-pub const GPBUFEN_DEFAULT: u16 = 0x5340;    // End of General-Purpose SRAM Buffer == ERXST default
-
 /// Struct for TX Buffer on the hardware
 /// TODO: Should be a singleton
 pub struct TxBuffer {
-    wrap_addr: u16,
+    start_addr: u16,
     // The following two fields are controlled by firmware
     next_addr: u16,
-    tail_addr: u16
+    tail_addr: u16,
 }
 
 impl TxBuffer {
     pub fn new() -> Self {
         TxBuffer {
-            wrap_addr: GPBUFST_DEFAULT,
+            start_addr: 0x0000,
-            next_addr: GPBUFST_DEFAULT + 1,
+            next_addr: 0x0001,
-            tail_addr: GPBUFST_DEFAULT
+            tail_addr: 0x0000,
         }
     }
 
-    pub fn set_wrap_addr(&mut self, addr: u16) {
+    pub fn set_start_addr(&mut self, addr: u16) {
-        self.wrap_addr = addr;
+        self.start_addr = addr;
     }
-    pub fn get_wrap_addr(& self) -> u16{
+    pub fn get_start_addr(&self) -> u16 {
-        self.wrap_addr
+        self.start_addr
     }
 
     pub fn set_next_addr(&mut self, addr: u16) {
         self.next_addr = addr;
     }
-    pub fn get_next_addr(& self) -> u16{
+    pub fn get_next_addr(&self) -> u16 {
         self.next_addr
     }
 
     pub fn set_tail_addr(&mut self, addr: u16) {
         self.tail_addr = addr;
     }
-    pub fn get_tail_addr(& self) -> u16{
+    pub fn get_tail_addr(&self) -> u16 {
         self.tail_addr
     }
 }
@@ -48,14 +44,14 @@ impl TxBuffer {
 /// TODO: Generalise MAC addresses
 pub struct TxPacket {
     frame: [u8; RAW_FRAME_LENGTH_MAX],
-    frame_length: usize
+    frame_length: usize,
 }
 
 impl TxPacket {
     pub fn new() -> Self {
         TxPacket {
             frame: [0; RAW_FRAME_LENGTH_MAX],
-            frame_length: 0
+            frame_length: 0,
         }
     }