More docs on the example

Add alternative pinout for nucleo board

Author: datdenkikniet

Cargo.toml

@@ -27,7 +27,7 @@ ieee802_3_miim = { version = "0.7", optional = true }
 cortex-m = "0.7"
 log = { version = "0.4", optional = true }
 
-# For rtic-telnet
+# For rtic-echo
 cortex-m-rtic = { version = "1.0", optional = true }
 defmt = { version = "0.3", optional = true }
 defmt-rtt = { version = "0.3", optional = true }
@@ -42,7 +42,7 @@ features = ["medium-ethernet", "proto-ipv4"]
 optional = true
 
 [features]
-default = [ "ieee802_3_miim" ]
+default = [ "ieee802_3_miim", "defmt" ]
 device-selected = []
 fence = []
 
@@ -69,6 +69,10 @@ stm32f779 = ["stm32f7xx-hal/stm32f779", "device-selected", "fence"]
 
 smoltcp-phy = ["smoltcp"]
 
+# Example features
+rtic-echo-example = [ "ieee802_3_miim", "cortex-m-rtic", "smoltcp-phy", "smoltcp/defmt", "smoltcp/medium-ethernet", "smoltcp/socket-tcp", "defmt", "defmt-rtt", "panic-probe", "systick-monotonic", "fugit" ]
+rtic-echo-example-altpin = [ ]
+
 [dev-dependencies]
 cortex-m = "0.7"
 cortex-m-rt = "0.7"
@@ -104,7 +108,7 @@ required-features = ["stm32f407", "smoltcp-phy", "smoltcp/socket-icmp"]
 
 [[example]]
 name = "rtic-echo"
-required-features = [ "ieee802_3_miim", "cortex-m-rtic", "smoltcp-phy", "smoltcp/defmt", "smoltcp/medium-ethernet", "smoltcp/socket-tcp", "defmt", "defmt-rtt", "panic-probe", "systick-monotonic", "fugit" ]
+required-features = [ "rtic-echo-example" ]
 
 [profile.release]
 debug = 2

examples/rtic-echo.rs

@@ -1,10 +1,18 @@
 #![no_std]
 #![no_main]
 
-// A simple TCP echo server using RTIC
-//
-// To run, use the following command:
-// DEFMT_LOG=info PROBE_RUN_CHIP=<probe-run chip> cargo run --example rtic-echo --features <chip here> --target <correct target for chip> --release --features="cortex-m-rtic smoltcp-phy smoltcp/medium-ethernet smoltcp/socket-tcp defmt-rtt panic-probe systick-monotonic fugit defmt smoltcp/defmt"
+//! A simple TCP echo server using RTIC.
+//!
+//! Starts a TCP echo server on port `1337` at `ADDRESS`. `ADDRESS` is `10.0.0.1/24` by default.
+//!
+//! By default, the example assumes that the default RMII pins are used.
+//! To use it on an stm32-nucleo-f746zg dev board, the `rtic-echo-example-altpin` feature should be enabled. This may work on other
+//! boards, but that hasn't been tested so your mileage may vary.
+//!
+//! To run this, install `probe-run` (`cargo install probe-run --version '~0.3'`), and ensure that `probe-run` can
+//! attach to your test board.
+//! Then, use the following command:
+//! DEFMT_LOG=info PROBE_RUN_CHIP=<probe-run chip> cargo run --example rtic-echo --features <chip here>,rtic-echo-example --target <correct target for chip> --release
 
 use defmt_rtt as _;
 use panic_probe as _;
@@ -160,14 +168,16 @@ mod app {
 
         interface.poll(now_fn()).unwrap();
 
-        let mut phy = crate::EthernetPhy::from_miim(mac, 0).unwrap();
-
-        defmt::info!(
-            "Resetting PHY as an extra step. Type: {}",
-            phy.ident_string()
-        );
+        if let Ok(mut phy) = crate::EthernetPhy::from_miim(mac, 0) {
+            defmt::info!(
+                "Resetting PHY as an extra step. Type: {}",
+                phy.ident_string()
+            );
 
-        phy.phy_init();
+            phy.phy_init();
+        } else {
+            defmt::info!("Not resetting unsupported PHY.");
+        }
 
         defmt::info!("Setup done.");
 
@@ -262,18 +272,24 @@ mod pins {
         pub type RxD0 = PC4<Input>;
         pub type RxD1 = PC5<Input>;
 
+        #[cfg(not(feature = "rtic-echo-example-altpin"))]
         pub type TxEn = PB11<Input>;
+        #[cfg(not(feature = "rtic-echo-example-altpin"))]
         pub type TxD0 = PB12<Input>;
 
+        #[cfg(all(feature = "rtic-echo-example-altpin"))]
+        pub type TxEn = PG11<Input>;
+        #[cfg(feature = "rtic-echo-example-altpin")]
+        pub type TxD0 = PG13<Input>;
+
         pub type Mdio = PA2<Alternate<11>>;
         pub type Mdc = PC1<Alternate<11>>;
 
-        #[allow(unused_variables)]
         pub fn get_pins(
             gpioa: gpioa::Parts,
             gpiob: gpiob::Parts,
             gpioc: gpioc::Parts,
-            gpiog: gpiog::Parts,
+            #[allow(unused_variables)] gpiog: gpiog::Parts,
         ) -> (
             EthPins<RefClk, Crs, TxEn, TxD0, TxD1, RxD0, RxD1>,
             Mdio,
@@ -285,11 +301,18 @@ mod pins {
             let rx_d0 = gpioc.pc4.into_floating_input();
             let rx_d1 = gpioc.pc5.into_floating_input();
 
+            #[cfg(not(feature = "rtic-echo-example-altpin"))]
             let (tx_en, tx_d0) = (
                 gpiob.pb11.into_floating_input(),
                 gpiob.pb12.into_floating_input(),
             );
 
+            #[cfg(feature = "rtic-echo-example-altpin")]
+            let (tx_en, tx_d0) = (
+                gpiog.pg11.into_floating_input(),
+                gpiog.pg13.into_floating_input(),
+            );
+
             #[cfg(feature = "stm32f4xx-hal")]
             let (mdio, mdc) = {
                 let mut mdio = gpioa.pa2.into_alternate();
@@ -322,7 +345,6 @@ mod pins {
     }
 
     #[cfg(any(feature = "stm32f1xx-hal"))]
-    #[allow(missing_docs)]
     mod pins {
         use stm32_eth::{
             hal::gpio::{Alternate, Input, PushPull, *},