Add nrf-usbd crate

Author: Dirbaio

.cargo/config

@@ -0,0 +1,4 @@
+
+
+[build]
+target = "thumbv7em-none-eabi"

.gitignore

@@ -0,0 +1,2 @@
+target
+Cargo.lock

Cargo.toml

@@ -0,0 +1,48 @@
+[workspace]
+members = [
+    ".",
+    "example",
+]
+
+[package]
+name = "nrf-usbd"
+version = "0.1.0"
+edition = "2018"
+
+
+[dependencies]
+cortex-m = "0.7.2"
+usb-device = "0.2.8"
+vcell = "0.1.3"
+
+[profile.dev]
+codegen-units = 1
+debug = 2
+debug-assertions = true
+incremental = false
+opt-level = 1
+overflow-checks = true
+
+[profile.release]
+codegen-units = 1
+debug = 2
+debug-assertions = false
+incremental = false
+lto = "fat"
+opt-level = 's'
+overflow-checks = false
+
+# do not optimize proc-macro crates = faster builds from scratch
+[profile.dev.build-override]
+codegen-units = 8
+debug = false
+debug-assertions = false
+opt-level = 0
+overflow-checks = false
+
+[profile.release.build-override]
+codegen-units = 8
+debug = false
+debug-assertions = false
+opt-level = 0
+overflow-checks = false

example/.cargo/config

@@ -0,0 +1,11 @@
+[target.'cfg(all(target_arch = "arm", target_os = "none"))']
+runner = "probe-run --chip nRF52840_xxAA"
+
+rustflags = [
+  "-C", "link-arg=--nmagic",
+  "-C", "link-arg=-Tlink.x",
+  "-C", "link-arg=-Tdefmt.x",
+]
+
+[build]
+target = "thumbv7em-none-eabi"

example/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "nrf-usbd-example"
+version = "0.1.0"
+edition = "2018"
+
+[features]
+default = [
+    "defmt-default",
+]
+defmt-default = []
+defmt-trace = []
+defmt-debug = []
+defmt-info = []
+defmt-warn = []
+defmt-error = []
+
+[dependencies]
+panic-probe = { version = "0.2.0", features = ["print-defmt"] }
+defmt = "0.2.0"
+defmt-rtt = "0.2.0"
+
+cortex-m = "0.7.2"
+cortex-m-rt = "0.6.12"
+
+nrf-usbd = { path = "../" }
+usb-device = "0.2.7"
+usbd-serial = "0.1.0"
+nrf52840-pac = "0.9.0"
+

example/build.rs

@@ -0,0 +1,31 @@
+//! This build script copies the `memory.x` file from the crate root into
+//! a directory where the linker can always find it at build time.
+//! For many projects this is optional, as the linker always searches the
+//! project root directory -- wherever `Cargo.toml` is. However, if you
+//! are using a workspace or have a more complicated build setup, this
+//! build script becomes required. Additionally, by requesting that
+//! Cargo re-run the build script whenever `memory.x` is changed,
+//! updating `memory.x` ensures a rebuild of the application with the
+//! new memory settings.
+
+use std::env;
+use std::fs::File;
+use std::io::Write;
+use std::path::PathBuf;
+
+fn main() {
+    // Put `memory.x` in our output directory and ensure it's
+    // on the linker search path.
+    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
+    File::create(out.join("memory.x"))
+        .unwrap()
+        .write_all(include_bytes!("memory.x"))
+        .unwrap();
+    println!("cargo:rustc-link-search={}", out.display());
+
+    // By default, Cargo will re-run a build script whenever
+    // any file in the project changes. By specifying `memory.x`
+    // here, we ensure the build script is only re-run when
+    // `memory.x` is changed.
+    println!("cargo:rerun-if-changed=memory.x");
+}

example/memory.x

@@ -0,0 +1,6 @@
+MEMORY
+{
+  /* NOTE 1 K = 1 KiBi = 1024 bytes */
+  FLASH : ORIGIN = 0x00000000, LENGTH = 1024K
+  RAM : ORIGIN = 0x20000000, LENGTH = 256K
+}

example/src/main.rs

@@ -0,0 +1,92 @@
+#![no_std]
+#![no_main]
+
+use defmt_rtt as _;
+use nrf_usbd::{UsbPeripheral, Usbd};
+// global logger
+use panic_probe as _;
+
+use core::str;
+use core::sync::atomic::{AtomicUsize, Ordering};
+use cortex_m_rt::entry;
+use defmt::*;
+use nrf52840_pac as pac;
+use usb_device::device::{UsbDeviceBuilder, UsbVidPid};
+use usbd_serial::{SerialPort, USB_CLASS_CDC};
+
+defmt::timestamp! {"{=u64}", {
+        static COUNT: AtomicUsize = AtomicUsize::new(0);
+        // NOTE(no-CAS) `timestamps` runs with interrupts disabled
+        let n = COUNT.load(Ordering::Relaxed);
+        COUNT.store(n + 1, Ordering::Relaxed);
+        n as u64
+    }
+}
+
+#[entry]
+fn main() -> ! {
+    let p = pac::Peripherals::take().unwrap();
+
+    info!("Enabling ext hfosc...");
+    p.CLOCK.tasks_hfclkstart.write(|w| unsafe { w.bits(1) });
+    while p.CLOCK.events_hfclkstarted.read().bits() != 1 {}
+
+    info!("Waiting for vbus...");
+    while !p.POWER.usbregstatus.read().vbusdetect().is_vbus_present() {}
+
+    //info!("Waiting for usbpwr...");
+    //// wait until USB 3.3V supply is stable
+    //while !p.POWER.events_usbpwrrdy.read().events_usbpwrrdy().bit() {}
+
+    info!("starting...");
+
+    let usb_bus = Usbd::new(Peripheral);
+    let mut serial = SerialPort::new(&usb_bus);
+
+    let mut usb_dev = UsbDeviceBuilder::new(&usb_bus, UsbVidPid(0x16c0, 0x27dd))
+        .product("nRF52840 Serial Port Demo")
+        .device_class(USB_CLASS_CDC)
+        .max_packet_size_0(64) // (makes control transfers 8x faster)
+        .build();
+
+    info!("started!");
+
+    loop {
+        if !usb_dev.poll(&mut [&mut serial]) {
+            continue;
+        }
+
+        let mut buf = [0u8; 64];
+
+        match serial.read(&mut buf) {
+            Ok(count) if count > 0 => {
+                let mut buf = &mut buf[..count];
+
+                info!("read: {=str}", unsafe { str::from_utf8_unchecked(buf) });
+
+                // Echo back in upper case
+                for c in buf.iter_mut() {
+                    if 0x61 <= *c && *c <= 0x7a {
+                        *c &= !0x20;
+                    }
+                }
+
+                info!("writing: {=str}", unsafe { str::from_utf8_unchecked(buf) });
+                while !buf.is_empty() {
+                    match serial.write(buf) {
+                        Ok(len) => buf = &mut buf[len..],
+                        _ => {}
+                    }
+                }
+
+                info!("write done")
+            }
+            _ => {}
+        }
+    }
+}
+
+struct Peripheral;
+unsafe impl UsbPeripheral for Peripheral {
+    const REGISTERS: *const () = pac::USBD::ptr() as *const ();
+}

errata.rs renamed to src/errata.rs

@@ -0,0 +1,17 @@
+//! USB peripheral driver for nRF microcontrollers.
+
+#![no_std]
+
+mod errata;
+mod pac;
+mod usbd;
+
+pub use usbd::Usbd;
+
+/// A trait for device-specific USB peripherals. Implement this to add support for a new hardware
+/// platform. Peripherals that have this trait must have the same register block as NRF52 USBD
+/// peripherals.
+pub unsafe trait UsbPeripheral: Send + Sync {
+    /// Pointer to the register block
+    const REGISTERS: *const ();
+}