drivers: udc: disable SOF interrupt by default

jfischer-no · jfischer-no · commit 4cc21ef179ad · 2025-04-07T11:23:23.000+02:00
Add Kconfig option to enable SOF interrupts.
Disable SOF interrupt in drivers that are maintainable and do not
obfuscate how interrupts are enabled. If the new Kconfig option is
disabled, no SOF events are passed to the higher layer.

Signed-off-by: Johann Fischer &lt;johann.fischer@nordicsemi.no&gt;
diff --git a/drivers/usb/udc/Kconfig b/drivers/usb/udc/Kconfig
@@ -32,6 +32,12 @@ config UDC_BUF_FORCE_NOCACHE
 	  Place the buffer pools in the nocache memory region if the driver
 	  cannot handle buffers in cached memory.
 
+config UDC_ENABLE_SOF
+	bool "SOF interrupt processing"
+	help
+	  Enabled SoF interrupts can cause a very high CPU load on high-speed
+	  controllers because the interrupt rate would be 125 µs.
+
 config UDC_WORKQUEUE
 	bool "Use a dedicate work queue for UDC drivers"
 	help
diff --git a/drivers/usb/udc/udc_ambiq.c b/drivers/usb/udc/udc_ambiq.c
@@ -157,8 +157,9 @@ static void udc_ambiq_evt_callback(const struct device *dev, am_hal_usb_dev_even
 	case AM_HAL_USB_DEV_EVT_BUS_RESET:
 		/* enable usb bus interrupts */
 		am_hal_usb_intr_usb_enable(priv->usb_handle,
-					   USB_CFG2_SOFE_Msk | USB_CFG2_ResumeE_Msk |
-						   USB_CFG2_SuspendE_Msk | USB_CFG2_ResetE_Msk);
+					   IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USB_CFG2_SOFE_Msk |))
+					   USB_CFG2_ResumeE_Msk |
+					   USB_CFG2_SuspendE_Msk | USB_CFG2_ResetE_Msk);
 		/* init the endpoint */
 		am_hal_usb_ep_init(priv->usb_handle, 0, 0, EP0_MPS);
 		/* Set USB device speed to HAL */
@@ -175,7 +176,7 @@ static void udc_ambiq_evt_callback(const struct device *dev, am_hal_usb_dev_even
 		udc_submit_event(dev, UDC_EVT_RESUME, 0);
 		break;
 	case AM_HAL_USB_DEV_EVT_SOF:
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 		break;
 	case AM_HAL_USB_DEV_EVT_SUSPEND:
 		/* Handle USB Suspend event, then set device state to suspended */
diff --git a/drivers/usb/udc/udc_common.c b/drivers/usb/udc/udc_common.c
@@ -180,6 +180,24 @@ int udc_submit_event(const struct device *dev,
 	return data->event_cb(dev, &drv_evt);
 }
 
+void udc_submit_sof_event(const struct device *dev,
+			  const int frame)
+{
+#if defined(CONFIG_UDC_ENABLE_SOF)
+	struct udc_data *data = dev->data;
+	struct udc_event drv_evt = {
+		.type = UDC_EVT_SOF,
+		.status = frame,
+		.dev = dev,
+	};
+
+	(void)data->event_cb(dev, &drv_evt);
+#else
+	ARG_UNUSED(dev);
+	ARG_UNUSED(frame);
+#endif
+}
+
 int udc_submit_ep_event(const struct device *dev,
 			struct net_buf *const buf,
 			const int err)
diff --git a/drivers/usb/udc/udc_common.h b/drivers/usb/udc/udc_common.h
@@ -156,6 +156,18 @@ int udc_submit_event(const struct device *dev,
 int udc_submit_ep_event(const struct device *dev,
 			struct net_buf *const buf,
 			const int err);
+
+/**
+ * @brief Helper function to send UDC SOF event to a higher level.
+ *
+ * Type of this event is hardcoded to UDC_EVT_SOF.
+ *
+ * @param[in] dev    Pointer to device struct of the driver instance
+ * @param[in] frame  Frame number
+ */
+void udc_submit_sof_event(const struct device *dev,
+			  const int frame);
+
 /**
  * @brief Helper function to enable endpoint.
  *
diff --git a/drivers/usb/udc/udc_dwc2.c b/drivers/usb/udc/udc_dwc2.c
@@ -2154,8 +2154,8 @@ static int udc_dwc2_init_controller(const struct device *dev)
 	sys_write32(USB_DWC2_GINTSTS_OEPINT | USB_DWC2_GINTSTS_IEPINT |
 		    USB_DWC2_GINTSTS_ENUMDONE | USB_DWC2_GINTSTS_USBRST |
 		    USB_DWC2_GINTSTS_WKUPINT | USB_DWC2_GINTSTS_USBSUSP |
-		    USB_DWC2_GINTSTS_INCOMPISOOUT | USB_DWC2_GINTSTS_INCOMPISOIN |
-		    USB_DWC2_GINTSTS_SOF,
+		    IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USB_DWC2_GINTSTS_SOF |))
+		    USB_DWC2_GINTSTS_INCOMPISOOUT | USB_DWC2_GINTSTS_INCOMPISOIN,
 		    (mem_addr_t)&base->gintmsk);
 
 	return 0;
@@ -2890,7 +2890,7 @@ static void udc_dwc2_isr_handler(const struct device *dev)
 
 			dsts = sys_read32((mem_addr_t)&base->dsts);
 			priv->sof_num = usb_dwc2_get_dsts_soffn(dsts);
-			udc_submit_event(dev, UDC_EVT_SOF, 0);
+			udc_submit_sof_event(dev, 0);
 		}
 
 		if (int_status & USB_DWC2_GINTSTS_USBRST) {
diff --git a/drivers/usb/udc/udc_it82xx2.c b/drivers/usb/udc/udc_it82xx2.c
@@ -17,9 +17,6 @@ LOG_MODULE_REGISTER(udc_it82xx2, CONFIG_UDC_DRIVER_LOG_LEVEL);
 
 #define DT_DRV_COMPAT ite_it82xx2_usb
 
-/* TODO: Replace this definition by Kconfig option */
-#define USB_DEVICE_CONFIG_SOF_NOTIFICATIONS (0U)
-
 #define IT8XXX2_IS_EXTEND_ENDPOINT(n) (USB_EP_GET_IDX(n) >= 4)
 
 #define IT82xx2_STATE_OUT_SHARED_FIFO_BUSY 0
@@ -1357,11 +1354,11 @@ static void it82xx2_usb_dc_isr(const void *arg)
 
 	/* sof received */
 	if (status & DC_SOF_RECEIVED) {
-		if (!USB_DEVICE_CONFIG_SOF_NOTIFICATIONS) {
+		if (!IS_ENABLED(CONFIG_UDC_ENABLE_SOF)) {
 			it82xx2_enable_sof_int(dev, false);
 		} else {
 			usb_regs->dc_interrupt_status = DC_SOF_RECEIVED;
-			udc_submit_event(dev, UDC_EVT_SOF, 0);
+			udc_submit_sof_event(dev, 0);
 		}
 		it82xx2_enable_resume_int(dev, false);
 		emit_resume_event(dev);
@@ -1411,7 +1408,7 @@ static void suspended_handler(struct k_work *item)
 
 	it82xx2_enable_resume_int(dev, true);
 
-	if (!USB_DEVICE_CONFIG_SOF_NOTIFICATIONS) {
+	if (!IS_ENABLED(CONFIG_UDC_ENABLE_SOF)) {
 		it82xx2_enable_sof_int(dev, true);
 	}
 
diff --git a/drivers/usb/udc/udc_kinetis.c b/drivers/usb/udc/udc_kinetis.c
@@ -653,7 +653,7 @@ static void usbfsotg_isr_handler(const struct device *dev)
 	}
 
 	if (istatus == USB_ISTAT_SOFTOK_MASK) {
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 	}
 
 	if (istatus == USB_ISTAT_ERROR_MASK) {
@@ -1016,7 +1016,7 @@ static int usbfsotg_init(const struct device *dev)
 	base->INTEN = (USB_INTEN_SLEEPEN_MASK  |
 		       USB_INTEN_STALLEN_MASK |
 		       USB_INTEN_TOKDNEEN_MASK |
-		       USB_INTEN_SOFTOKEN_MASK |
+		       IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USB_INTEN_SOFTOKEN_MASK |))
 		       USB_INTEN_ERROREN_MASK |
 		       USB_INTEN_USBRSTEN_MASK);
 
diff --git a/drivers/usb/udc/udc_mcux_ehci.c b/drivers/usb/udc/udc_mcux_ehci.c
@@ -531,7 +531,7 @@ usb_status_t USB_DeviceNotificationTrigger(void *handle, void *msg)
 		udc_submit_event(dev, UDC_EVT_VBUS_READY, 0);
 		break;
 	case kUSB_DeviceNotifySOF:
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 		break;
 	default:
 		udc_mcux_event_submit(dev, mcux_msg);
diff --git a/drivers/usb/udc/udc_mcux_ip3511.c b/drivers/usb/udc/udc_mcux_ip3511.c
@@ -531,7 +531,7 @@ usb_status_t USB_DeviceNotificationTrigger(void *handle, void *msg)
 		udc_submit_event(dev, UDC_EVT_VBUS_READY, 0);
 		break;
 	case kUSB_DeviceNotifySOF:
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 		break;
 	default:
 		udc_mcux_event_submit(dev, mcux_msg);
diff --git a/drivers/usb/udc/udc_nrf.c b/drivers/usb/udc/udc_nrf.c
@@ -526,7 +526,7 @@ static void usbd_event_handler(nrf_usbd_common_evt_t const *const hal_evt)
 		udc_submit_event(udc_nrf_dev, UDC_EVT_RESET, 0);
 		break;
 	case NRF_USBD_COMMON_EVT_SOF:
-		udc_submit_event(udc_nrf_dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(udc_nrf_dev, 0);
 		udc_sof_check_iso_out(udc_nrf_dev);
 		break;
 	case NRF_USBD_COMMON_EVT_SUSPEND:
@@ -559,7 +559,7 @@ static void udc_nrf_power_handler(nrfx_power_usb_evt_t pwr_evt)
 		break;
 	case NRFX_POWER_USB_EVT_READY:
 		LOG_DBG("POWER event ready");
-		nrf_usbd_common_start(true);
+		nrf_usbd_common_start(IS_ENABLED(CONFIG_UDC_ENABLE_SOF));
 		break;
 	case NRFX_POWER_USB_EVT_REMOVED:
 		LOG_DBG("POWER event removed");
diff --git a/drivers/usb/udc/udc_numaker.c b/drivers/usb/udc/udc_numaker.c
@@ -171,7 +171,9 @@ static inline void numaker_usbd_sw_connect(const struct device *dev)
 	base->INTSTS = base->INTSTS;
 
 	/* Enable relevant interrupts */
-	base->INTEN = USBD_INT_BUS | USBD_INT_USB | USBD_INT_FLDET | USBD_INT_WAKEUP | USBD_INT_SOF;
+	base->INTEN = USBD_INT_BUS | USBD_INT_USB | USBD_INT_FLDET |
+		      IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USBD_INT_SOF |))
+		      USBD_INT_WAKEUP;
 
 	/* Clear SE0 for connect */
 	base->SE0 &= ~USBD_DRVSE0;
@@ -1290,7 +1292,7 @@ static void numaker_udbd_isr(const struct device *dev)
 		base->INTSTS = USBD_INTSTS_SOFIF_Msk;
 
 		/* UDC stack would handle bottom-half processing */
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 	}
 
 	/* USB Setup/EP */
diff --git a/drivers/usb/udc/udc_renesas_ra.c b/drivers/usb/udc/udc_renesas_ra.c
@@ -79,7 +79,7 @@ static void udc_renesas_ra_event_handler(usbd_callback_arg_t *p_args)
 		break;
 
 	case USBD_EVENT_SOF:
-		udc_submit_event(dev, UDC_EVT_SOF, 0);
+		udc_submit_sof_event(dev, 0);
 		break;
 
 	default:
diff --git a/drivers/usb/udc/udc_rpi_pico.c b/drivers/usb/udc/udc_rpi_pico.c
@@ -600,6 +600,7 @@ static void rpi_pico_isr_handler(const struct device *dev)
 	if (status & USB_INTS_DEV_SOF_BITS) {
 		handled |= USB_INTS_DEV_SOF_BITS;
 		sys_read32((mm_reg_t)&base->sof_rd);
+		udc_submit_sof_event(dev, 0);
 	}
 
 	if (status & USB_INTS_DEV_CONN_DIS_BITS) {
@@ -921,7 +922,7 @@ static int udc_rpi_pico_enable(const struct device *dev)
 	sys_write32(USB_SIE_CTRL_EP0_INT_1BUF_BITS, (mm_reg_t)&base->sie_ctrl);
 
 	/* Enable interrupts */
-	sys_write32(USB_INTE_DEV_SOF_BITS |
+	sys_write32(IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USB_INTE_DEV_SOF_BITS |))
 		    USB_INTE_SETUP_REQ_BITS |
 		    USB_INTE_DEV_RESUME_FROM_HOST_BITS |
 		    USB_INTE_DEV_SUSPEND_BITS |
diff --git a/drivers/usb/udc/udc_skeleton.c b/drivers/usb/udc/udc_skeleton.c
@@ -233,6 +233,10 @@ static int udc_skeleton_init(const struct device *dev)
 		return -EIO;
 	}
 
+	if (IS_ENABLED(CONFIG_UDC_ENABLE_SOF)) {
+		LOG_INF("Enable SOF interrupt");
+	}
+
 	return 0;
 }
 
diff --git a/drivers/usb/udc/udc_stm32.c b/drivers/usb/udc/udc_stm32.c
@@ -155,7 +155,7 @@ void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd)
 {
 	struct udc_stm32_data *priv = hpcd2data(hpcd);
 
-	udc_submit_event(priv->dev, UDC_EVT_SOF, 0);
+	udc_submit_sof_event(priv->dev, 0);
 }
 
 static int usbd_ctrl_feed_dout(const struct device *dev, const size_t length)
diff --git a/samples/subsys/usb/uac2_explicit_feedback/prj.conf b/samples/subsys/usb/uac2_explicit_feedback/prj.conf
@@ -3,6 +3,7 @@ CONFIG_I2S=y
 #USB related configs
 CONFIG_USB_DEVICE_STACK_NEXT=y
 CONFIG_USBD_AUDIO2_CLASS=y
+CONFIG_UDC_ENABLE_SOF=y
 CONFIG_SAMPLE_USBD_PID=0x000E
 CONFIG_SAMPLE_USBD_PRODUCT="UAC2 explicit feedback sample"
 
diff --git a/samples/subsys/usb/uac2_implicit_feedback/prj.conf b/samples/subsys/usb/uac2_implicit_feedback/prj.conf
@@ -3,6 +3,7 @@ CONFIG_I2S=y
 #USB related configs
 CONFIG_USB_DEVICE_STACK_NEXT=y
 CONFIG_USBD_AUDIO2_CLASS=y
+CONFIG_UDC_ENABLE_SOF=y
 CONFIG_SAMPLE_USBD_PID=0x000F
 CONFIG_SAMPLE_USBD_PRODUCT="UAC2 implicit feedback sample"
 
diff --git a/subsys/usb/device_next/class/Kconfig.uac2 b/subsys/usb/device_next/class/Kconfig.uac2
@@ -4,6 +4,7 @@
 
 config USBD_AUDIO2_CLASS
 	bool "USB Audio 2 class support [EXPERIMENTAL]"
+	depends on UDC_ENABLE_SOF
 	help
 	  USB Audio 2 device class support.
 
diff --git a/tests/drivers/udc/prj.conf b/tests/drivers/udc/prj.conf
@@ -5,6 +5,7 @@ CONFIG_LOG=y
 CONFIG_ZTEST=y
 
 CONFIG_UDC_DRIVER=y
+CONFIG_UDC_ENABLE_SOF=y
 CONFIG_UDC_BUF_COUNT=16
 CONFIG_UDC_BUF_POOL_SIZE=16384
 CONFIG_UDC_DRIVER_LOG_LEVEL_INF=y
diff --git a/tests/subsys/usb/device_next/prj.conf b/tests/subsys/usb/device_next/prj.conf
@@ -6,6 +6,7 @@ CONFIG_ZTEST=y
 
 CONFIG_USB_DEVICE_STACK_NEXT=y
 CONFIG_USBD_LOOPBACK_CLASS=y
+CONFIG_UDC_ENABLE_SOF=y
 
 CONFIG_UHC_DRIVER=y
 CONFIG_USB_HOST_STACK=y

Original file line number	Diff line number	Diff line change
`@@ -653,7 +653,7 @@ static void usbfsotg_isr_handler(const struct device *dev)`
`653`	`653`	`}`
`654`	`654`
`655`	`655`	`if (istatus == USB_ISTAT_SOFTOK_MASK) {`
`656`		`- udc_submit_event(dev, UDC_EVT_SOF, 0);`
	`656`	`+ udc_submit_sof_event(dev, 0);`
`657`	`657`	`}`
`658`	`658`
`659`	`659`	`if (istatus == USB_ISTAT_ERROR_MASK) {`
`@@ -1016,7 +1016,7 @@ static int usbfsotg_init(const struct device *dev)`
`1016`	`1016`	`base->INTEN = (USB_INTEN_SLEEPEN_MASK \|`
`1017`	`1017`	`USB_INTEN_STALLEN_MASK \|`
`1018`	`1018`	`USB_INTEN_TOKDNEEN_MASK \|`
`1019`		`- USB_INTEN_SOFTOKEN_MASK \|`
	`1019`	`+ IF_ENABLED(CONFIG_UDC_ENABLE_SOF, (USB_INTEN_SOFTOKEN_MASK \|))`
`1020`	`1020`	`USB_INTEN_ERROREN_MASK \|`
`1021`	`1021`	`USB_INTEN_USBRSTEN_MASK);`
`1022`	`1022`