cfg rework, transport enum

Remove much of the cfg blocks from varios places. Where possible, new concise cfgs have been introduced. Adds a transport to replace dyn.
esp-rs · Sep 6, 2023 · d06e14e · d06e14e
1 parent ad563b4
commit d06e14e
Show file tree

Hide file tree

Showing 8 changed files with 119 additions and 88 deletions.
diff --git a/build.rs b/build.rs
@@ -88,4 +88,19 @@ fn main() {
         println!("cargo:rerun-if-changed=ld/ld/esp32s3_rom.x");
         println!("cargo:rustc-link-arg=-Tld/esp32s3_rom.x");
     }
+
+    emit_cfg();
+}
+
+fn emit_cfg() {
+    #[cfg(any(
+        feature = "esp32c3",
+        feature = "esp32s3",
+        feature = "esp32c6",
+        feature = "esp32h2"
+    ))]
+    println!("cargo:rustc-cfg=usb_device");
+
+    #[cfg(any(feature = "esp32s2", feature = "esp32s3"))]
+    println!("cargo:rustc-cfg=usb0");
 }
diff --git a/src/io.rs b/src/io.rs
@@ -5,64 +5,69 @@ use heapless::Deque;
 use crate::protocol::InputIO;
 
 pub mod uart;
-#[cfg(any(
-    feature = "esp32c3",
-    feature = "esp32s3",
-    feature = "esp32c6",
-    feature = "esp32h2"
-))]
+#[cfg(usb_device)]
 pub mod usb_serial_jtag;
 
 const RX_QUEUE_SIZE: usize = crate::targets::MAX_WRITE_BLOCK + 0x400;
 
 static mut RX_QUEUE: Deque<u8, RX_QUEUE_SIZE> = Deque::new();
 
+trait UartMarker: InputIO {}
+trait UsbSerialJtagMarker: InputIO {}
+trait UsbOtgMarker: InputIO {}
+
 #[non_exhaustive]
-pub enum Transport<S, J> {
+pub enum Transport<S, J, U> {
     Uart(S),
-    #[cfg(any(
-        feature = "esp32c3",
-        feature = "esp32s3",
-        feature = "esp32c6",
-        feature = "esp32h2"
-    ))]
+    #[cfg(usb_device)]
     UsbSerialJtag(J),
-    // #[cfg(any(feature = "esp32s2", feature = "esp32s3"))]
-    // UsbOtg(U),
-    #[doc(hidden)] // a type to "use" the generic params
-    __Hidden(PhantomData<S>, PhantomData<J> /* , PhantomData<U> */),
+    #[cfg(usb0)]
+    UsbOtg(U),
+    #[doc(hidden)]
+    __Hidden(PhantomData<J>, PhantomData<U>),
 }
 
-impl<S, J> InputIO for Transport<S, J>
+impl<S, J, U> InputIO for Transport<S, J, U>
 where
-    S: InputIO,
-    J: InputIO,
+    S: UartMarker,
+    J: UsbSerialJtagMarker,
+    U: UsbOtgMarker,
 {
     fn recv(&mut self) -> u8 {
         match self {
             Transport::Uart(s) => s.recv(),
-            #[cfg(any(
-                feature = "esp32c3",
-                feature = "esp32s3",
-                feature = "esp32c6",
-                feature = "esp32h2"
-            ))]
+            #[cfg(usb_device)]
             Transport::UsbSerialJtag(j) => j.recv(),
-            _ => unreachable!(),
+            _ => todo!(),
         }
     }
 
     fn send(&mut self, data: &[u8]) {
         match self {
             Transport::Uart(s) => s.send(data),
-            #[cfg(any(
-                feature = "esp32c3",
-                feature = "esp32s3",
-                feature = "esp32c6",
-                feature = "esp32h2"
-            ))]
+            #[cfg(usb_device)]
             Transport::UsbSerialJtag(j) => j.send(data),
-            _ => unreachable!(),
+            _ => todo!(),
         }
     }
 }
+
+pub struct Noop;
+
+impl InputIO for Noop {
+    fn recv(&mut self) -> u8 {
+        todo!()
+    }
+
+    fn send(&mut self, _data: &[u8]) {
+        todo!()
+    }
+}
+
+impl UartMarker for Noop {}
+impl UsbSerialJtagMarker for Noop {}
+impl UsbOtgMarker for Noop {}
+
+impl<T: UartMarker> UartMarker for &mut T {}
+impl<T: UsbSerialJtagMarker> UsbSerialJtagMarker for &mut T {}
+impl<T: UsbOtgMarker> UsbOtgMarker for &mut T {}
diff --git a/src/io/uart.rs b/src/io/uart.rs
@@ -1,4 +1,4 @@
-use super::RX_QUEUE;
+use super::{UartMarker, RX_QUEUE};
 use crate::{
     hal::{peripherals::UART0, prelude::*, uart::Instance, Uart},
     protocol::InputIO,
@@ -15,6 +15,8 @@ impl<T: Instance> InputIO for Uart<'_, T> {
     }
 }
 
+impl<T: Instance> UartMarker for Uart<'_, T> {}
+
 #[interrupt]
 fn UART0() {
     let uart = unsafe { &*UART0::ptr() };
@@ -30,7 +32,7 @@ fn UART0() {
         // the read _must_ be a word read so the hardware correctly detects the read and
         // pops the byte from the fifo cast the result to a u8, as only the
         // first byte contains the data
-        let data = unsafe { (uart.fifo.as_ptr() as *mut u32).offset(offset).read() } as u8;
+        let data = unsafe { uart.fifo.as_ptr().offset(offset).read() } as u8;
         unsafe { RX_QUEUE.push_back(data).unwrap() };
     }
 

diff --git a/src/io/usb_serial_jtag.rs b/src/io/usb_serial_jtag.rs
@@ -1,4 +1,4 @@
-use super::RX_QUEUE;
+use super::{UsbSerialJtagMarker, RX_QUEUE};
 use crate::{
     hal::{
         prelude::*,
@@ -18,6 +18,8 @@ impl InputIO for UsbSerialJtag<'_> {
     }
 }
 
+impl UsbSerialJtagMarker for UsbSerialJtag<'_> {}
+
 #[interrupt]
 unsafe fn USB_DEVICE() {
     let usj = crate::hal::peripherals::USB_DEVICE::steal();

diff --git a/src/lib.rs b/src/lib.rs
@@ -15,9 +15,6 @@ pub use esp32h2_hal as hal;
 pub use esp32s2_hal as hal;
 #[cfg(feature = "esp32s3")]
 pub use esp32s3_hal as hal;
-// Due to a bug in esp-hal this MUST be included in the root.
-#[cfg(target_arch = "riscv32")]
-pub use hal::interrupt;
 // Re-export the correct target based on which feature is active
 #[cfg(feature = "esp32")]
 pub use targets::Esp32 as target;
@@ -44,18 +41,15 @@ pub mod targets;
 #[derive(Debug)]
 pub enum TransportMethod {
     Uart,
-    #[cfg(any(
-        feature = "esp32c3",
-        feature = "esp32s3",
-        feature = "esp32c6",
-        feature = "esp32h2"
-    ))]
+    #[cfg(usb_device)]
     UsbSerialJtag,
-    #[cfg(any(feature = "esp32s2", feature = "esp32s3"))]
+    #[cfg(usb0)]
     UsbOtg,
 }
 
 pub fn detect_transport() -> TransportMethod {
+    #[allow(unused)]
+    use targets::{EspUsbOtgId, EspUsbSerialJtagId};
     #[repr(C)]
     struct Uart {
         baud_rate: u32,
@@ -72,28 +66,13 @@ pub fn detect_transport() -> TransportMethod {
     extern "C" {
         fn esp_flasher_rom_get_uart() -> *const Uart;
     }
-    #[cfg(any(feature = "esp32c3", feature = "esp32c6", feature = "esp32h2"))]
-    const USB_SERIAL_JTAG: u8 = 3;
-    #[cfg(any(feature = "esp32s3"))]
-    const USB_SERIAL_JTAG: u8 = 4;
-
-    #[cfg(feature = "esp32s3")]
-    const USB_OTG: u8 = 3;
-    #[cfg(feature = "esp32s2")]
-    const USB_OTG: u8 = 2;
-
     let device = unsafe { esp_flasher_rom_get_uart() };
     let num = unsafe { (*device).buff_uart_no };
     match num {
-        #[cfg(any(
-            feature = "esp32c3",
-            feature = "esp32s3",
-            feature = "esp32c6",
-            feature = "esp32h2"
-        ))]
-        USB_SERIAL_JTAG => TransportMethod::UsbSerialJtag,
-        #[cfg(any(feature = "esp32s2", feature = "esp32s3"))]
-        USB_OTG => TransportMethod::UsbOtg,
+        #[cfg(usb_device)]
+        target::USB_SERIAL_JTAG_ID => TransportMethod::UsbSerialJtag,
+        #[cfg(usb0)]
+        target::USB_OTG_ID => TransportMethod::UsbOtg,
         _ => TransportMethod::Uart,
     }
 }
diff --git a/src/main.rs b/src/main.rs
@@ -8,14 +8,35 @@ use flasher_stub::hal::uart::{
 };
 use flasher_stub::{
     hal::{clock::ClockControl, interrupt, peripherals, prelude::*, Uart, IO},
-    io::Transport,
+    io::Noop,
     protocol::Stub,
     targets,
 };
 use static_cell::StaticCell;
 
 const MSG_BUFFER_SIZE: usize = targets::MAX_WRITE_BLOCK + 0x400;
 
+// TODO this sucks, but default generic parameters are not used when inference
+// fails, meaning that we _have_ to specifiy the types here Seems like work on this has stalled: https://github.com/rust-lang/rust/issues/27336, note that I tried the feature and it didn't work.
+#[cfg(not(any(usb_device, usb0)))]
+type Transport =
+    flasher_stub::io::Transport<&'static mut Uart<'static, crate::peripherals::UART0>, Noop, Noop>;
+#[cfg(all(usb_device, not(usb0)))]
+type Transport = flasher_stub::io::Transport<
+    &'static mut Uart<'static, crate::peripherals::UART0>,
+    &'static mut flasher_stub::hal::UsbSerialJtag<'static>,
+    Noop,
+>;
+#[cfg(all(not(usb_device), usb0))]
+type Transport =
+    flasher_stub::io::Transport<&'static mut Uart<'static, crate::peripherals::UART0>, Noop, Noop>; // TODO replace Noop with usb type later
+#[cfg(all(usb_device, usb0))]
+type Transport = flasher_stub::io::Transport<
+    &'static mut Uart<'static, crate::peripherals::UART0>,
+    &'static mut flasher_stub::hal::UsbSerialJtag<'static>,
+    Noop, // TODO replace Noop with usb type later
+>;
+
 #[flasher_stub::hal::entry]
 fn main() -> ! {
     let peripherals = peripherals::Peripherals::take();
@@ -79,12 +100,7 @@ fn main() -> ! {
                 StaticCell::new();
             Transport::Uart(unsafe { TRANSPORT.init(serial) })
         }
-        #[cfg(any(
-            feature = "esp32c3",
-            feature = "esp32s3",
-            feature = "esp32c6",
-            feature = "esp32h2"
-        ))]
+        #[cfg(usb_device)]
         flasher_stub::TransportMethod::UsbSerialJtag => {
             let mut usb_serial = flasher_stub::hal::UsbSerialJtag::new(
                 peripherals.USB_DEVICE,
@@ -101,7 +117,7 @@ fn main() -> ! {
                 StaticCell::new();
             Transport::UsbSerialJtag(unsafe { TRANSPORT.init(usb_serial) })
         }
-        #[cfg(any(feature = "esp32s2", feature = "esp32s3"))]
+        #[cfg(usb0)]
         flasher_stub::TransportMethod::UsbOtg => unimplemented!(),
     };
 

diff --git a/src/protocol.rs b/src/protocol.rs
@@ -40,20 +40,7 @@ pub struct Stub<T> {
     decompressor: tinfl_decompressor,
     last_error: Option<Error>,
     in_flash_mode: bool,
-    #[cfg(feature = "esp32c3")]
-    target: crate::targets::Esp32c3,
-    #[cfg(feature = "esp32c6")]
-    target: crate::targets::Esp32c6,
-    #[cfg(feature = "esp32h2")]
-    target: crate::targets::Esp32h2,
-    #[cfg(feature = "esp32c2")]
-    target: crate::targets::Esp32c2,
-    #[cfg(feature = "esp32")]
-    target: crate::targets::Esp32,
-    #[cfg(feature = "esp32s3")]
-    target: crate::targets::Esp32s3,
-    #[cfg(feature = "esp32s2")]
-    target: crate::targets::Esp32s2,
+    target: crate::target,
 }
 
 fn slice_to_struct<T: Sized + Copy>(slice: &[u8]) -> Result<T, Error> {

diff --git a/src/targets.rs b/src/targets.rs
@@ -399,3 +399,28 @@ impl EspCommon for Esp32c3 {}
 impl EspCommon for Esp32c2 {}
 impl EspCommon for Esp32c6 {}
 impl EspCommon for Esp32h2 {}
+
+pub trait EspUsbSerialJtagId {
+    /// The ID returned for USB_SERIAL_JTAG from `esp_flasher_rom_get_uart`
+    const USB_SERIAL_JTAG_ID: u8 = 3; // default for most chips is 3
+}
+
+impl EspUsbSerialJtagId for Esp32c3 {}
+impl EspUsbSerialJtagId for Esp32c6 {}
+impl EspUsbSerialJtagId for Esp32h2 {}
+impl EspUsbSerialJtagId for Esp32s3 {
+    const USB_SERIAL_JTAG_ID: u8 = 4;
+}
+
+pub trait EspUsbOtgId {
+    /// The ID returned for USB_OTG from `esp_flasher_rom_get_uart`
+    const USB_OTG_ID: u8;
+}
+
+impl EspUsbOtgId for Esp32s2 {
+    const USB_OTG_ID: u8 = 2;
+}
+
+impl EspUsbOtgId for Esp32s3 {
+    const USB_OTG_ID: u8 = 3;
+}