stm32-hal2 2.1.10

//! USB support, including for simulated COM ports. This module is a thin wrapper required to work with
//! the `stm32_usbd` crate.
//!
//! Requires the `usb` feature.
//!
//! Used on F303, L4x2, L4x3, L4x5, L5, G0, and G4. F4, L4x6 and H7 use the `usb_otg` module.
//! For G0 series, USB is only available on G0B0, G0B1, G0C1, which the PAC doesn't yet differentiate,
//! and this library doesn't yet support.

/*
 Small caveat, the pac for the l4x5 exposes a USB peripheral instead
 of a OTG peripheral, even though this chart
 https://www.st.com/en/microcontrollers-microprocessors/stm32l4-series.html
 shows that the stm32l475 has OTG.

 Further inspection shows that the generated pac for the l4x5 has a USB peripheral
 while the l4r5 has an OTG, but this crate doesn't currently seem to support the
 l4r5 variant.

 Strangely, the register modification commands for the l4x5 have OTG in their names
*/

use core::borrow::BorrowMut;

use cfg_if::cfg_if;
pub use stm32_usbd::UsbBus;
use stm32_usbd::{MemoryAccess, UsbPeripheral};

// use usb_device::{bus::UsbBusAllocator, prelude::*};
// use usb_device::class_prelude::UsbBus as UsbBus_;
// use usbd_serial::{self, SerialPort};
#[cfg(any(feature = "l4", feature = "l5", feature = "g0"))]
use crate::pac::PWR;
use crate::{pac, pac::USB, util::rcc_en_reset};

/// Represents a Universal Serial Bus (USB) peripheral. Functionality is implemented through the
/// implemented `stm32_usbd::UsbPeripheral` trait.
pub struct Peripheral {
    /// USB Register Block
    pub regs: USB,
}

unsafe impl Sync for Peripheral {}
// unsafe impl Send for Peripheral {} // todo: Required/do we want this?

unsafe impl UsbPeripheral for Peripheral {
    const REGISTERS: *const () = USB::ptr() as *const ();

    // Embedded pull-up resistor on USB_DP line
    #[cfg(feature = "f3")]
    const DP_PULL_UP_FEATURE: bool = false;

    #[cfg(not(feature = "f3"))]
    const DP_PULL_UP_FEATURE: bool = true;

    // Pointer to the endpoint memory
    // todo: This is the L4 setting. Is this right?
    // L4 Reference manual, Table 2. USB SRAM is on APB1, at this address:
    #[cfg(any(feature = "l4", feature = "wb"))]
    const EP_MEMORY: *const () = 0x4000_6c00 as _;

    #[cfg(feature = "l5")]
    const EP_MEMORY: *const () = 0x5000_d800 as _;

    #[cfg(feature = "g0")]
    const EP_MEMORY: *const () = 0x4000_5c00 as _;

    #[cfg(feature = "c0")]
    const EP_MEMORY: *const () = 0x4000_9800 as _; // Table 7, USBRAM entry

    #[cfg(any(feature = "f3", feature = "g4"))]
    const EP_MEMORY: *const () = 0x4000_6000 as _;

    // Endpoint memory size in bytes
    // F303 subvariants have diff mem sizes and bits/word scheme: 0B/C use 512 size and 1x16 bits/word.
    // F303D/E use 1024 bytes, and 2x16 bits/word.
    #[cfg(feature = "f3")]
    const EP_MEMORY_SIZE: usize = 512;
    // todo: Feature-gate various memory sizes

    #[cfg(any(feature = "l4", feature = "l5", feature = "g4", feature = "wb"))]
    const EP_MEMORY_SIZE: usize = 1_024;

    #[cfg(feature = "g0")]
    const EP_MEMORY_SIZE: usize = 2_048;

    #[cfg(feature = "c0")]
    const EP_MEMORY_SIZE: usize = 2_048; // Table 154.

    // Endpoint memory access scheme.
    // Set to `true` if "2x16 bits/word" access scheme is used, otherwise set to `false`.
    #[cfg(any(feature = "l4", feature = "l5", feature = "g4", feature = "wb"))]
    const EP_MEMORY_ACCESS: MemoryAccess = MemoryAccess::Word16x2;

    #[cfg(any(feature = "f3", feature = "g0"))]
    // F3 uses 1x16 or 2x16 depending on variant. G0 uses a 32-bit word.
    const EP_MEMORY_ACCESS: MemoryAccess = MemoryAccess::Word16x2;

    #[cfg(any(feature = "c0", feature = "h5"))]
    const EP_MEMORY_ACCESS: MemoryAccess = MemoryAccess::Word32x1;

    fn enable() {
        let rcc = unsafe { &*pac::RCC::ptr() };

        cfg_if! {
            if #[cfg(feature = "l4")] {
                cfg_if! {
                    if #[cfg(feature = "l4x5")] {
                        rcc_en_reset!(ahb2, otgfs, rcc); // Why does the l4x5 have USB peripheral but OTG names?
                    } else {
                        rcc_en_reset!(apb1, usbfs, rcc);
                    }
                }
            } else if #[cfg(feature = "l5")] {
                rcc.apb1enr2().modify(|_, w| w.usbfsen().bit(true));
                rcc.apb1rstr2().modify(|_, w| w.usbfsrst().bit(true));
                rcc.apb1rstr2().modify(|_ , w| w.usbfsrst().clear_bit());
            } else if #[cfg(feature = "wb")] {
                rcc.apb1enr1().modify(|_, w| w.usben().bit(true));
                rcc.apb1rstr1().modify(|_, w| w.usbfsrst().bit(true));
                rcc.apb1rstr1().modify(|_ , w| w.usbfsrst().clear_bit());
            } else { // G0, G4
                rcc_en_reset!(apb1, usb, rcc);
            }
        }
    }

    fn startup_delay() {
        // There is a chip specific startup delay, around 1µs.
        // todo: Come back to this. This value current assumes 1µs
        // todo for an L4 running at full speed.
        cortex_m::asm::delay(80);
    }
}

/// Type of the UsbBus
pub type UsbBusType = UsbBus<Peripheral>;

#[cfg(any(feature = "l4", feature = "l5", feature = "g0"))]
/// Enables the Vdd USB power supply. Note that we also need to enable `PWREN` in APB1,
/// but we handle this using the RTC setup. Use a raw pointer if doing this without the RTC
/// already set up.
pub fn enable_usb_pwr() {
    // Enable VddUSB
    let pwr = unsafe { &*pac::PWR::ptr() };
    pwr.cr2().modify(|_, w| w.usv().bit(true));
}

// todo: We need to sort out the SerialPort traits to makme this work. Non-trivial.

// /// Helper to handle chunked USB writing. Blocks.
// pub fn write_usb<B: UsbBus_, RS: BorrowMut<[u8]>, WS: BorrowMut<[u8]>>(
//     usb_serial: SerialPort<'static, B, RS, WS>,
//     usb_dev: &mut UsbDevice<'static, UsbBusType>,
//     buf: &[u8],
//     msg_len: usize
// ) {
//     let mut offset = 0;
//     while offset < msg_len {
//         match usb_serial.write(&buf[offset..msg_len]) {
//             Ok(0) | Err(UsbError::WouldBlock) => {
//                 usb_dev.poll(&mut [usb_serial]);
//             }
//             Ok(written) => offset += written,
//             Err(e) => {
//                 // defmt::warn!("USB write error: {:?}", e);
//                 break;
//             }
//         }
//     }

//     while usb_serial.flush().err() == Some(UsbError::WouldBlock) {
//         usb_dev.poll(&mut [usb_serial]);
//     }
// }