Merge #18756

18756: drivers/usbdev_synopsys_dwc2: add EFM32 support r=chrysn a=gschorcht

### Contribution description

This PR provides the changes for the Synopsys USB OTG IP core DWC2 driver for EFM32 MCUs. It also provides the changes of the board definition for `stk3600` and `stk3700` for testing.

### Testing procedure

`tests/usbus_hid` should work on the EFM32 boards `stk3600` (EFM32LG family) and `stk3700` (EFM32GG family).

It is already tested for a `sltb009a` board (EFM32GG12 family).

### Issues/PRs references


Co-authored-by: Gunar Schorcht <gunar@schorcht.net>

boards/common/silabs/include/usbdev_cfg_otg_fs.h

@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2019 Koen Zandberg
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @ingroup     boards_common_silabs
+ * @{
+ *
+ * @file
+ * @brief       Common configuration for EFM32 OTG FS peripheral
+ *
+ * @author      Koen Zandberg <koen@bergzand.net>
+ */
+
+#ifndef USBDEV_CFG_OTG_FS_H
+#define USBDEV_CFG_OTG_FS_H
+
+#include "periph_cpu.h"
+#include "usbdev_efm32.h"
+#include "usbdev_synopsys_dwc2.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Enable the full speed USB OTG peripheral
+ */
+#define DWC2_USB_OTG_FS_ENABLED
+
+/**
+ * @brief Common USB OTG FS configuration
+ */
+static const dwc2_usb_otg_fshs_config_t dwc2_usb_otg_fshs_config[] = {
+    {
+        .periph   = USB_OTG_FS_PERIPH_BASE,
+        .type     = DWC2_USB_OTG_FS,
+        .phy      = DWC2_USB_OTG_PHY_BUILTIN,
+    }
+};
+
+/**
+ * @brief Number of available USB OTG peripherals
+ */
+#define USBDEV_NUMOF    ARRAY_SIZE(dwc2_usb_otg_fshs_config)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* USBDEV_CFG_OTG_FS_H */
+/** @} */

boards/sltb009a/Kconfig

@@ -19,6 +19,7 @@ config BOARD_SLTB009A
     select HAS_PERIPH_SPI
     select HAS_PERIPH_TIMER
     select HAS_PERIPH_UART
+    select HAS_PERIPH_USBDEV
     select HAVE_SAUL_GPIO
 
 source "$(RIOTBOARD)/common/silabs/Kconfig"

boards/sltb009a/Makefile.features

@@ -10,5 +10,6 @@ FEATURES_PROVIDED += periph_rtt
 FEATURES_PROVIDED += periph_spi
 FEATURES_PROVIDED += periph_timer
 FEATURES_PROVIDED += periph_uart
+FEATURES_PROVIDED += periph_usbdev
 
 include $(RIOTBOARD)/common/silabs/Makefile.features

boards/sltb009a/include/periph_conf.h

@@ -23,7 +23,7 @@
 #include "cpu.h"
 #include "periph_cpu.h"
 #include "em_cmu.h"
-#include "usbdev_synopsys_dwc2.h"
+#include "usbdev_cfg_otg_fs.h"
 
 #ifdef __cplusplus
 extern "C" {

boards/stk3600/Kconfig

@@ -21,6 +21,7 @@ config BOARD_STK3600
     select HAS_PERIPH_SPI
     select HAS_PERIPH_TIMER
     select HAS_PERIPH_UART
+    select HAS_PERIPH_USBDEV
 
     select HAVE_SAUL_GPIO
     select MODULE_SILABS_AEM if TEST_KCONFIG

boards/stk3600/Makefile.features

@@ -11,5 +11,6 @@ FEATURES_PROVIDED += periph_rtt
 FEATURES_PROVIDED += periph_spi
 FEATURES_PROVIDED += periph_timer
 FEATURES_PROVIDED += periph_uart
+FEATURES_PROVIDED += periph_usbdev
 
 include $(RIOTBOARD)/common/silabs/Makefile.features

boards/stk3600/include/periph_conf.h

@@ -23,6 +23,7 @@
 #include "cpu.h"
 #include "periph_cpu.h"
 #include "em_cmu.h"
+#include "usbdev_cfg_otg_fs.h"
 
 #ifdef __cplusplus
 extern "C" {

boards/stk3700/Kconfig

@@ -21,6 +21,7 @@ config BOARD_STK3700
     select HAS_PERIPH_SPI
     select HAS_PERIPH_TIMER
     select HAS_PERIPH_UART
+    select HAS_PERIPH_USBDEV
 
     select HAVE_SAUL_GPIO
     select MODULE_SILABS_AEM if TEST_KCONFIG

boards/stk3700/Makefile.features

@@ -11,5 +11,6 @@ FEATURES_PROVIDED += periph_rtt
 FEATURES_PROVIDED += periph_spi
 FEATURES_PROVIDED += periph_timer
 FEATURES_PROVIDED += periph_uart
+FEATURES_PROVIDED += periph_usbdev
 
 include $(RIOTBOARD)/common/silabs/Makefile.features

boards/stk3700/include/periph_conf.h

@@ -23,6 +23,7 @@
 #include "cpu.h"
 #include "periph_cpu.h"
 #include "em_cmu.h"
+#include "usbdev_cfg_otg_fs.h"
 
 #ifdef __cplusplus
 extern "C" {

cpu/efm32/Makefile.dep

@@ -13,4 +13,8 @@ endif
 # include CPU family module
 USEMODULE += cpu_$(CPU_FAM)
 
+ifneq (,$(filter periph_usbdev,$(USEMODULE)))
+  USEMODULE += usbdev_synopsys_dwc2
+endif
+
 include $(RIOTCPU)/cortexm_common/Makefile.dep

cpu/efm32/Makefile.include

@@ -9,16 +9,25 @@ include $(RIOTCPU)/efm32/families/$(CPU_FAM)/Makefile.include
 # Export vars for Gecko SDK librail Makefile
 export EFM32_LIBRAIL_BLOB_NAME
 
+INCLUDES += -I$(RIOTCPU)/efm32/include/vendor
+
 ifeq (,$(EFM32_HEADER))
   $(error Header file for $(CPU_MODEL) is missing)
 endif
 
 # the size of riotboot on the EFM32 exceeds the default value
-RIOTBOOT_LEN ?= 0x2000
+ifneq (,$(filter periph_usbdev,$(USEMODULE)))
+  RIOTBOOT_LEN ?= 0x4000
+else
+  RIOTBOOT_LEN ?= 0x2000
+endif
 
 # the em_device.h header requires a global define with the cpu model
 CFLAGS += -D$(call uppercase_and_underscore,$(CPU_MODEL))
 
+# to be able to use the family as define
+CFLAGS += -DCPU_FAM_$(call uppercase_and_underscore,$(CPU_FAM))
+
 # include EFM32 specific driver headers
 INCLUDES += -I$(RIOTCPU)/efm32/include/drivers
 

cpu/efm32/include/periph_cpu.h

@@ -23,6 +23,7 @@
 #include "kernel_defines.h"
 #include "mutex.h"
 
+#include "cpu.h"
 #include "cpu_conf.h"
 
 #if defined(_SILICON_LABS_32B_SERIES_2)
@@ -640,6 +641,11 @@ typedef struct {
     IRQn_Type irq;          /**< the devices base IRQ channel */
 } uart_conf_t;
 
+/**
+ * @brief   CPU provides own pm_off() function
+ */
+#define PROVIDES_PM_OFF
+
 /**
  * @brief   CPU provides own pm_off() function
  */

cpu/efm32/periph/Kconfig

@@ -8,3 +8,4 @@
 config MODULE_PERIPH
     bool
     default y
+    select MODULE_USBDEV_SYNOPSYS_DWC2 if MODULE_PERIPH_USBDEV

drivers/usbdev_synopsys_dwc2/usbdev_synopsys_dwc2.c

@@ -47,6 +47,8 @@
 #include "usbdev_stm32.h"
 #elif defined(MCU_ESP32)
 #include "usbdev_esp32.h"
+#elif defined(MCU_EFM32)
+#include "usbdev_efm32.h"
 #else
 #error "MCU not supported"
 #endif
@@ -578,15 +580,29 @@ static void _sleep_periph(const dwc2_usb_otg_fshs_config_t *conf)
     /* Unblocking STM32_PM_STOP during suspend on the stm32f446 breaks
      * while (un)blocking works on the stm32f401, needs more
      * investigation with a larger set of chips */
-#ifdef STM32_USB_OTG_CID_1x
+#if defined(STM32_USB_OTG_CID_1x)
     pm_unblock(STM32_PM_STOP);
+#elif defined(MCU_EFM32)
+    /* switch USB core clock source either to LFXO or LFRCO */
+    CMU_ClockSelectSet(cmuClock_USB, CLOCK_LFA);
+    pm_unblock(EFM32_PM_MODE_EM2);
 #endif
 }
 
 static void _wake_periph(const dwc2_usb_otg_fshs_config_t *conf)
 {
-#ifdef STM32_USB_OTG_CID_1x
+#if defined(STM32_USB_OTG_CID_1x)
     pm_block(STM32_PM_STOP);
+#elif defined(MCU_EFM32)
+    pm_block(EFM32_PM_MODE_EM2);
+    /* switch USB core clock source either to USHFRCO or HFCLK */
+#if defined(CPU_FAM_EFM32GG12B)
+    CMU_ClockSelectSet(cmuClock_USB, cmuSelect_USHFRCO);
+#elif defined(CPU_FAM_EFM32GG) || defined(CPU_FAM_EFM32LG)
+    CMU_ClockSelectSet(cmuClock_USB, cmuSelect_HFCLK);
+#else
+#error "EFM32 family not yet supported"
+#endif
 #endif
     *_pcgcctl_reg(conf) &= ~USB_OTG_PCGCCTL_STOPCLK;
     _flush_rx_fifo(conf);
@@ -648,6 +664,7 @@ static void _usbdev_init(usbdev_t *dev)
     const dwc2_usb_otg_fshs_config_t *conf = usbdev->config;
 
 #if defined(MCU_STM32)
+
     /* Block both STOP and STANDBY, STOP is unblocked during USB suspend
      * status */
     pm_block(STM32_PM_STOP);
@@ -662,7 +679,9 @@ static void _usbdev_init(usbdev_t *dev)
     periph_clk_en(conf->ahb, conf->rcc_mask);
 
     _enable_gpio(conf);
+
 #elif defined(MCU_ESP32)
+
     usb_phy_handle_t phy_hdl;               /* only needed temporarily */
 
     usb_phy_config_t phy_conf = {
@@ -674,6 +693,42 @@ static void _usbdev_init(usbdev_t *dev)
     if (usb_new_phy(&phy_conf, &phy_hdl) != ESP_OK) {
         LOG_ERROR("usbdev: Install USB PHY failed\n");
     }
+
+#elif defined(MCU_EFM32)
+
+    /* Block EM2 and EM3. In EM2, most USB core registers are reset and the
+     * FIFO content is lost. EM2 is unblocked during USB suspend */
+    pm_block(EFM32_PM_MODE_EM3);
+    pm_block(EFM32_PM_MODE_EM2);
+
+#if defined(CPU_FAM_EFM32GG12B)
+    /* select USHFRCO as USB clock and set the tuning to 48 MHz */
+    CMU_ClockSelectSet(cmuClock_USB, cmuSelect_USHFRCO);
+    CMU_USHFRCOBandSet(cmuUSHFRCOFreq_48M0Hz);
+    /* enable USB clock recovery */
+    CMU->USBCRCTRL = CMU_USBCRCTRL_USBCREN;
+    /* select USHFRCO as USB rate clock source and enable it */
+    CMU_ClockSelectSet(cmuClock_USBR, cmuSelect_USHFRCO);
+    CMU_ClockEnable(cmuClock_USBR, true);
+#elif defined(CPU_FAM_EFM32GG) || defined(CPU_FAM_EFM32LG)
+    /* select HFCLK as USB PHY clock source */
+    CMU_ClockSelectSet(cmuClock_USB, cmuSelect_HFCLK);
+    /* enable USB system clock */
+    CMU_ClockEnable(cmuClock_USB, true);
+    /* enable USB core clock */
+    CMU_ClockEnable(cmuClock_USBC, true);
+#else
+#error "EFM32 family not yet supported"
+#endif
+
+    /* enable USB peripheral clock */
+    CMU_ClockEnable(cmuClock_USB, true);
+
+    /* USB PHY is enabled before core reset */
+    USB->ROUTE = USB_ROUTE_PHYPEN;
+    /* USB VBUSEN pin is not yet used */
+    /* USB_ROUTELOC0 = location */
+
 #else
 #error "MCU not supported"
 #endif
@@ -851,7 +906,8 @@ static void _usbdev_init(usbdev_t *dev)
         _global_regs(usbdev->config)->GCCFG &= ~USB_OTG_GCCFG_PWRDWN;
     }
 
-#elif defined(MCU_ESP32)
+#elif defined(MCU_ESP32) || defined(MCU_EFM32)
+
     /* Force Vbus Detect values and ID detect values to device mode */
     _global_regs(usbdev->config)->GOTGCTL |= USB_OTG_GOTGCTL_VBVALOVAL |
                                              USB_OTG_GOTGCTL_VBVALOEN |
@@ -933,6 +989,9 @@ static void _usbdev_init(usbdev_t *dev)
 #if defined(MCU_STM32)
     /* Unmask the interrupt in the NVIC */
     NVIC_EnableIRQ(conf->irqn);
+#elif defined(MCU_EFM32)
+    /* Unmask the interrupt in the NVIC */
+    NVIC_EnableIRQ(USB_IRQn);
 #elif defined(MCU_ESP32)
     void isr_otg_fs(void *arg);
     /* Allocate the interrupt and connect it with USB interrupt source */
@@ -1249,11 +1308,16 @@ static void _read_packet(dwc2_usb_otg_fshs_out_ep_t *st_ep)
                  USB_OTG_GRXSTSP_BCNT_Pos;
 
     /* Packet is copied on the update status and copied on the transfer
-     * complete status*/
+     * complete status */
     if (pkt_status == DWC2_PKTSTS_DATA_UPDT ||
         pkt_status == DWC2_PKTSTS_SETUP_UPDT) {
+#if defined(MCU_EFM32)
+        /* TODO For some reason a short delay is required here on EFM32. It has
+         * to be investigated further. A delay of 1 msec is inserted for now. */
+        ztimer_sleep(ZTIMER_MSEC, 1);
+#endif
         _copy_rxfifo(usbdev, st_ep->out_buf, len);
-#if defined(STM32_USB_OTG_CID_2x) || defined(MCU_ESP32)
+#if !defined(STM32_USB_OTG_CID_1x)
         /* CID 2x doesn't signal SETUP_COMP on non-zero length packets, signal
          * the TR_COMPLETE event immediately */
         if (st_ep->ep.num == 0 && len) {
@@ -1394,7 +1458,7 @@ void isr_otg_fs(void *arg)
 
     _isr_common(usbdev);
 }
-#endif /* ESP32_USB_OTG_FS_ENABLED */
+#endif /* DWC2_USB_OTG_FS_ENABLED */
 
 #ifdef DWC2_USB_OTG_HS_ENABLED
 void isr_otg_hs(void *arg)
@@ -1406,7 +1470,17 @@ void isr_otg_hs(void *arg)
 
     _isr_common(usbdev);
 }
-#endif /* ESP32_USB_OTG_HS_ENABLED */
+#endif /* DWC2_USB_OTG_HS_ENABLED */
+
+#elif defined(MCU_EFM32)
+
+ void isr_usb(void)
+{
+    /* Take the first device from the list */
+    dwc2_usb_otg_fshs_t *usbdev = &_usbdevs[0];
+
+    _isr_common(usbdev);
+}
 
 #else
 #error "MCU not supported"