Add USB driver

Cargo.toml

@@ -26,6 +26,7 @@ embassy-sync = { version = "0.6.0", optional = true }
 embassy-futures = { version = "0.1.1", optional = true }
 embassy-hal-internal = { version = "0.2.0", default-features = false }
 embassy-time = { version = "0.3.0", optional = true }
+embassy-usb-driver = { version = "0.1.0", features = ["defmt"] }
 critical-section = "1.1.2"
 
 riscv-rt = { version = "0.12.2", optional = true }
@@ -42,7 +43,6 @@ embedded-hal-async = "1.0.0"
 chrono = { version = "0.4.38", default-features = false, optional = true }
 mcan = { version = "0.5.0", optional = true }
 
-
 [build-dependencies]
 # hpm-metapac = { path = "../hpm-data/build/hpm-metapac", default-features = false, features = [
 #     "metadata",
@@ -60,7 +60,7 @@ rt = ["dep:riscv-rt", "hpm-metapac/rt"]
 defmt = ["dep:defmt"]
 time = ["dep:embassy-time"]
 chrono = ["dep:chrono"]
-
+usb-pin-reuse-hpm5300 = []
 embassy = [
     "dep:embassy-sync",
     "dep:embassy-futures",

README.md

@@ -14,7 +14,7 @@ This crate is a working-in-progress and not ready for use.
 | HPM6700    | ✓   | ✓    | ✓       | ✓      | ✓+   | ✓+   | ✓+  | ✓+  | ✓+  |     |     |     |     |
 | HPM6300    | ✓   | ✓    | ✓       | ✓      |      |      |     |     |     |     |     |     |     |
 | HPM6200    | ✓   |      |         |        |      |      |     |     |     |     |     |     |     |
-| HPM5300    | ✓   | ✓    | ✓       | ✓      | ✓+   | ✓+   | ✓+  | ✓+  | ✓+  |     | ✓   |     | ✓   |
+| HPM5300    | ✓   | ✓    | ✓       | ✓      | ✓+   | ✓+   | ✓+  | ✓+  | ✓+  |     | ✓   | ✓   | ✓   |
 | HPM6800    | ✓   |      |         |        |      |      |     |     |     |     |     |     |     |
 | HPM6E00    | ✓   | ✓    | ✓       | ✓      | ✓+   | ✓+   | ✓+  | ✓+  | ✓+  |     |     |     |     |
 
@@ -73,6 +73,9 @@ This crate is a working-in-progress and not ready for use.
   - [x] basic `mcan` wrapper
   - ~~[ ] async driver~~, better impl it in the App layer, see Mi motor demo
   - [ ] TSU management
+- [x] USB
+  - [x] Device
+  - [ ] Host
 
 ### Long term Plans
 

build.rs

@@ -395,8 +395,18 @@ fn main() {
                         })
                     }
                 }
+
                 // if regs.kind == "dac"
             }
+
+            // Usb is special
+            #[cfg(feature = "usb-pin-reuse-hpm5300")]
+            if p.name == "USB0" {
+                g.extend(quote! {
+                    pin_trait_impl!(crate::usb::DmPin, USB0, PA24, 0);
+                    pin_trait_impl!(crate::usb::DpPin, USB0, PA25, 0);
+                })
+            }
         }
     }
 

examples/hpm5300evk/.cargo/config.toml

@@ -7,7 +7,6 @@ runner = [
     "probe-rs", "run",
     "--chip", "HPM5361",
     "--chip-description-path", "../../HPMicro.yaml",
-#    "--chip-description-path", "../../../flash-algo/target/definition.yaml",
     "--protocol","jtag",
     "--log-format", "{t} {L} {F}:{l} {s}",
 ]
@@ -37,4 +36,4 @@ rustflags = [
 build-std = ["core"]
 
 [env]
-DEFMT_LOG = "info"
+DEFMT_LOG = "trace"

examples/hpm5300evk/Cargo.toml

@@ -5,7 +5,12 @@ edition = "2021"
 
 [dependencies]
 # hpm5301 is a subset of hpm5361, either is ok if you have the 5301 board.
-hpm-hal = { path = "../..", features = ["rt", "embassy", "hpm5361"] }
+hpm-hal = { path = "../..", features = [
+    "rt",
+    "embassy",
+    "hpm5361",
+    "usb-pin-reuse-hpm5300",
+] }
 
 panic-halt = "0.2.0"
 riscv-rt = "0.12.2"
@@ -31,7 +36,13 @@ embedded-hal-bus = "0.2.0"
 assign-resources = "0.4.1"
 mcan = "0.5.0"
 embassy-sync = "0.6.0"
-
+embassy-usb = { version = "0.3.0", features = [
+    "defmt",
+    "max-handler-count-8",
+    "max-interface-count-8",
+] }
+usbd-hid = "0.8"
+static_cell = "2"
 
 [profile.release]
 strip = false   # symbols are not flashed to the microcontroller, so don't strip them.

examples/hpm5300evk/src/bin/usb.rs

@@ -0,0 +1,115 @@
+#![no_main]
+#![no_std]
+#![feature(type_alias_impl_trait)]
+#![feature(abi_riscv_interrupt)]
+#![feature(impl_trait_in_assoc_type)]
+
+use defmt::info;
+use embassy_executor::Spawner;
+use embassy_usb::class::cdc_acm::{CdcAcmClass, Receiver, Sender, State};
+use embassy_usb::driver::EndpointError;
+use embassy_usb::Builder;
+use futures_util::future::join;
+use hal::usb::{Instance, UsbDriver};
+use hpm_hal::{bind_interrupts, peripherals};
+use {defmt_rtt as _, hpm_hal as hal, riscv_rt as _};
+
+bind_interrupts!(struct Irqs {
+    USB0 => hal::usb::InterruptHandler<peripherals::USB0>;
+});
+
+#[embassy_executor::main(entry = "hpm_hal::entry")]
+async fn main(_spawner: Spawner) -> ! {
+    let p = hal::init(Default::default());
+
+    let usb_driver = hal::usb::UsbDriver::new(p.USB0, p.PA24, p.PA25);
+
+    // Create embassy-usb Config
+    let mut config = embassy_usb::Config::new(0xc0de, 0xcafe);
+    config.manufacturer = Some("hpm-hal");
+    config.product = Some("USB-serial example");
+    config.serial_number = Some("12345678");
+
+    // Required for windows compatibility.
+    // https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.1/kconfig/CONFIG_CDC_ACM_IAD.html#help
+    config.device_class = 0xEF;
+    config.device_sub_class = 0x02;
+    config.device_protocol = 0x01;
+    config.composite_with_iads = true;
+
+    // Create embassy-usb DeviceBuilder using the driver and config.
+    // It needs some buffers for building the descriptors.
+    let mut config_descriptor = [0; 256];
+    let mut bos_descriptor = [0; 256];
+    let mut control_buf = [0; 64];
+
+    let mut state = State::new();
+
+    let mut builder = Builder::new(
+        usb_driver,
+        config,
+        &mut config_descriptor,
+        &mut bos_descriptor,
+        &mut [], // no msos descriptors
+        &mut control_buf,
+    );
+
+    // Create classes on the builder.
+    let class = CdcAcmClass::new(&mut builder, &mut state, 64);
+
+    // Build the builder.
+    let mut usb = builder.build();
+
+    // Run the USB device.
+    let usb_fut = usb.run();
+
+    // Do stuff with the class!
+    let echo_fut = async {
+        // class.wait_connection().await;
+        let (mut sender, mut reader) = class.split();
+        sender.wait_connection().await;
+        reader.wait_connection().await;
+        info!("Connected");
+        let _ = echo(&mut reader, &mut sender).await;
+        info!("Disconnected");
+    };
+
+    // Run everything concurrently.
+    join(usb_fut, echo_fut).await;
+
+    loop {
+        embassy_time::Timer::after_millis(500).await;
+    }
+}
+
+struct Disconnected {}
+
+impl From<EndpointError> for Disconnected {
+    fn from(val: EndpointError) -> Self {
+        match val {
+            EndpointError::BufferOverflow => panic!("Buffer overflow"),
+            EndpointError::Disabled => Disconnected {},
+        }
+    }
+}
+
+async fn echo<'d, T: Instance + 'd>(
+    reader: &mut Receiver<'d, UsbDriver<'d, T>>,
+    sender: &mut Sender<'d, UsbDriver<'d, T>>,
+) -> Result<(), Disconnected> {
+    let mut buf = [0; 64];
+    loop {
+        let n = reader.read_packet(&mut buf).await?;
+        let data = &buf[..n];
+        info!("echo data: {:x}, len: {}", data, n);
+        sender.write_packet(data).await?;
+        // Clear bufffer
+        buf = [0; 64];
+    }
+}
+
+#[panic_handler]
+fn panic(info: &core::panic::PanicInfo) -> ! {
+    defmt::info!("panic: {:?}", defmt::Debug2Format(&info));
+    loop {}
+}