drivers: regulator: add set callback API and driver for Nordic USB VBUS regulator

boards/native/nrf_bsim/nrf54lm20bsim_nrf54lm20a_cpuapp.dts

@@ -33,7 +33,7 @@
 			/delete-node/ vpr@4c000;
 			/delete-node/ interrupt-controller@f0000000;
 			/delete-node/ spi@4d000;
-			/delete-node/ usbhs@5a000;
+			/delete-node/ usbhs_wrapper@5a000;
 			/delete-node/ i2c@c6000;
 			/delete-node/ spi@c6000;
 			/delete-node/ i2c@c7000;

boards/nordic/nrf54lm20dk/nrf54lm20_a_b_cpuapp_common.dtsi

@@ -51,6 +51,10 @@
 	regulator-initial-mode = <NRF5X_REG_MODE_DCDC>;
 };
 
+&vregusb {
+	status = "okay";
+};
+
 &grtc {
 	owned-channels = <0 1 2 3 4 5 6 7 8 9 10 11>;
 	/* Channels 7-11 reserved for Zero Latency IRQs, 3-4 for FLPR */

drivers/regulator/CMakeLists.txt

@@ -22,6 +22,7 @@ zephyr_library_sources_ifdef(CONFIG_REGULATOR_NPM1100 regulator_npm1100.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_NPM13XX regulator_npm13xx.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_NPM2100 regulator_npm2100.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_NPM6001 regulator_npm6001.c)
+zephyr_library_sources_ifdef(CONFIG_REGULATOR_NRF_VREGUSB regulator_nrf_vregusb.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_NXP_VREF regulator_nxp_vref.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_NXP_VREFV1 regulator_nxp_vrefv1.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_PCA9420 regulator_pca9420.c)

drivers/regulator/Kconfig

@@ -42,6 +42,7 @@ source "drivers/regulator/Kconfig.npm1100"
 source "drivers/regulator/Kconfig.npm13xx"
 source "drivers/regulator/Kconfig.npm2100"
 source "drivers/regulator/Kconfig.npm6001"
+source "drivers/regulator/Kconfig.nrf_vregusb"
 source "drivers/regulator/Kconfig.nxp_vref"
 source "drivers/regulator/Kconfig.nxp_vrefv1"
 source "drivers/regulator/Kconfig.pca9420"

drivers/regulator/Kconfig.nrf_vregusb

@@ -0,0 +1,16 @@
+# Copyright Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+config REGULATOR_NRF_VREGUSB
+	bool "Nordic USB VBUS regulator driver"
+	default y
+	depends on DT_HAS_NORDIC_VREGUSB_REGULATOR_ENABLED
+	help
+	  Enable Nordic USB VBUS regulator driver.
+
+config REGULATOR_NRF_VREGUSB_INIT_PRIORITY
+	int "Nordic VBUS regulator driver init priority"
+	default KERNEL_INIT_PRIORITY_DEVICE
+	depends on REGULATOR_NRF_VREGUSB
+	help
+	  Init priority for the Nordic USB VBUS regulator driver.

drivers/regulator/regulator_nrf_vregusb.c

@@ -0,0 +1,135 @@
+/*
+ * Copyright Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <nrfx.h>
+#include <errno.h>
+#include <stdint.h>
+#include <zephyr/drivers/regulator.h>
+#include <zephyr/logging/log.h>
+#include <hal/nrf_vregusb.h>
+
+LOG_MODULE_REGISTER(vregusb, CONFIG_REGULATOR_LOG_LEVEL);
+
+struct vregusb_config {
+	struct regulator_common_config common;
+	NRF_VREGUSB_Type *base;
+	void (*irq_enable_func)(const struct device *dev);
+	void (*irq_disable_func)(const struct device *dev);
+};
+
+struct vregusb_data {
+	struct regulator_common_data data;
+	regulator_callback_t cb;
+	const void *user_data;
+};
+
+static void vregusb_isr(void *const arg)
+{
+	const struct device *const dev = arg;
+	const struct vregusb_config *const config = dev->config;
+	struct vregusb_data *const data = dev->data;
+	NRF_VREGUSB_Type *const base = config->base;
+	struct regulator_event event;
+
+	if (nrf_vregusb_event_check(base, NRF_VREGUSB_EVENT_VBUS_DETECTED)) {
+		LOG_DBG("VBUS detected");
+		nrf_vregusb_event_clear(base, NRF_VREGUSB_EVENT_VBUS_DETECTED);
+		event.type = REGULATOR_VOLTAGE_DETECTED;
+	}
+
+	if (nrf_vregusb_event_check(base, NRF_VREGUSB_EVENT_VBUS_REMOVED)) {
+		LOG_DBG("VBUS removed");
+		nrf_vregusb_event_clear(base, NRF_VREGUSB_EVENT_VBUS_REMOVED);
+		event.type = REGULATOR_VOLTAGE_REMOVED;
+	}
+
+	if (data->cb != NULL) {
+		data->cb(dev, &event, data->user_data);
+	}
+}
+
+static int vregusb_enable(const struct device *const dev)
+{
+	const struct vregusb_config *const config = dev->config;
+	NRF_VREGUSB_Type *const base = config->base;
+
+	nrf_vregusb_int_enable(base, NRF_VREGUSB_INT_VBUS_DETECTED_MASK |
+				     NRF_VREGUSB_INT_VBUS_REMOVED_MASK);
+	config->irq_enable_func(dev);
+
+	nrf_vregusb_task_trigger(base, NRF_VREGUSB_TASK_START);
+
+	return 0;
+}
+
+static int vregusb_disable(const struct device *const dev)
+{
+	const struct vregusb_config *const config = dev->config;
+	NRF_VREGUSB_Type *const base = config->base;
+
+	config->irq_disable_func(dev);
+	nrf_vregusb_task_trigger(base, NRF_VREGUSB_TASK_STOP);
+
+	return 0;
+}
+
+static int vregusb_set_callback(const struct device *const dev,
+				regulator_callback_t cb, const void *const user_data)
+{
+	struct vregusb_data *const data = dev->data;
+
+	data->cb = cb;
+	data->user_data = user_data;
+
+	return 0;
+}
+
+static int regulator_vregusb_init(const struct device *const dev)
+{
+	regulator_common_data_init(dev);
+
+	return 0;
+}
+
+static DEVICE_API(regulator, api) = {
+	.enable = vregusb_enable,
+	.disable = vregusb_disable,
+	.set_callback = vregusb_set_callback,
+};
+
+#define DT_DRV_COMPAT nordic_vregusb_regulator
+
+#define REGULATOR_VREGUSB_DEFINE(n)						\
+	static void irq_enable_func_##n(const struct device *const dev)		\
+	{									\
+		IRQ_CONNECT(DT_INST_IRQN(n),					\
+			    DT_INST_IRQ(n, priority),				\
+			    vregusb_isr,					\
+			    DEVICE_DT_INST_GET(n),				\
+			    0);							\
+										\
+		irq_enable(DT_INST_IRQN(n));					\
+	}									\
+										\
+	static void irq_disable_func_##n(const struct device *const dev)	\
+	{									\
+		irq_disable(DT_INST_IRQN(n));					\
+	}									\
+										\
+	static struct vregusb_data data_##n;					\
+										\
+	static const struct vregusb_config config_##n = {			\
+		.base = (void *)(DT_INST_REG_ADDR(n)),				\
+		.common = REGULATOR_DT_INST_COMMON_CONFIG_INIT(n),		\
+		.irq_enable_func = irq_enable_func_##n,				\
+		.irq_disable_func = irq_disable_func_##n,			\
+	};									\
+										\
+	DEVICE_DT_INST_DEFINE(n, regulator_vregusb_init, NULL,			\
+			      &data_##n, &config_##n,				\
+			      POST_KERNEL,					\
+			      CONFIG_REGULATOR_NRF_VREGUSB_INIT_PRIORITY, &api);\
+
+DT_INST_FOREACH_STATUS_OKAY(REGULATOR_VREGUSB_DEFINE)

drivers/usb/udc/Kconfig.dwc2

@@ -9,6 +9,7 @@ config UDC_DWC2
 	select NRFS if NRFS_HAS_VBUS_DETECTOR_SERVICE
 	select NRFS_VBUS_DETECTOR_SERVICE_ENABLED if NRFS_HAS_VBUS_DETECTOR_SERVICE
 	select EVENTS
+	select REGULATOR if SOC_SERIES_NRF54L || SOC_SERIES_NRF92X
 	help
 	  DWC2 USB device controller driver.
 

drivers/usb/udc/udc_dwc2_vendor_quirks.h

@@ -326,14 +326,13 @@ DT_INST_FOREACH_STATUS_OKAY(QUIRK_NRF_USBHS_DEFINE)
 
 #if DT_HAS_COMPAT_STATUS_OKAY(nordic_nrf_usbhs_nrf54l)
 
-#define USBHS_DT_WRAPPER_REG_ADDR(n) UINT_TO_POINTER(DT_INST_REG_ADDR_BY_NAME(n, wrapper))
+#define USBHS_DT_WRAPPER_REG_ADDR(n) UINT_TO_POINTER(DT_REG_ADDR(DT_INST_PARENT(n)))
 
 #include <nrfx.h>
 #include <zephyr/logging/log.h>
 #include <zephyr/drivers/clock_control.h>
 #include <zephyr/drivers/clock_control/nrf_clock_control.h>
-
-#define NRF_DEFAULT_IRQ_PRIORITY 1
+#include <zephyr/drivers/regulator.h>
 
 /*
  * On USBHS, we cannot access the DWC2 register until VBUS is detected and
@@ -345,42 +344,46 @@ DT_INST_FOREACH_STATUS_OKAY(QUIRK_NRF_USBHS_DEFINE)
 static K_EVENT_DEFINE(usbhs_events);
 #define USBHS_VBUS_READY	BIT(0)
 
+const static struct device *const vregusb_dev =
+	DEVICE_DT_GET(DT_PHANDLE(DT_INST_PARENT(0), regulator));
 static struct onoff_manager *pclk24m_mgr;
 static struct onoff_client pclk24m_cli;
 
-static void vregusb_isr(const void *arg)
+static void vregusb_event_cb(const struct device *dev,
+			     const struct regulator_event *const evt,
+			     const void *const user_data)
 {
-	const struct device *dev = arg;
+	ARG_UNUSED(dev);
+	const struct device *const udc_dev = user_data;
 
-	if (NRF_VREGUSB->EVENTS_VBUSDETECTED) {
-		NRF_VREGUSB->EVENTS_VBUSDETECTED = 0;
+	if (evt->type == REGULATOR_VOLTAGE_DETECTED) {
 		k_event_post(&usbhs_events, USBHS_VBUS_READY);
-		udc_submit_event(dev, UDC_EVT_VBUS_READY, 0);
+		udc_submit_event(udc_dev, UDC_EVT_VBUS_READY, 0);
 	}
 
-	if (NRF_VREGUSB->EVENTS_VBUSREMOVED) {
-		NRF_VREGUSB->EVENTS_VBUSREMOVED = 0;
+	if (evt->type == REGULATOR_VOLTAGE_REMOVED) {
 		k_event_set_masked(&usbhs_events, 0, USBHS_VBUS_READY);
-		udc_submit_event(dev, UDC_EVT_VBUS_REMOVED, 0);
+		udc_submit_event(udc_dev, UDC_EVT_VBUS_REMOVED, 0);
 	}
 }
 
 static inline int usbhs_init_vreg_and_clock(const struct device *dev)
 {
-	IRQ_CONNECT(VREGUSB_IRQn, NRF_DEFAULT_IRQ_PRIORITY,
-		    vregusb_isr, DEVICE_DT_INST_GET(0), 0);
+	LOG_MODULE_DECLARE(udc_dwc2, CONFIG_UDC_DRIVER_LOG_LEVEL);
+	int err;
 
-	NRF_VREGUSB->INTEN = VREGUSB_INTEN_VBUSDETECTED_Msk |
-			     VREGUSB_INTEN_VBUSREMOVED_Msk;
-	NRF_VREGUSB->TASKS_START = 1;
+	err = regulator_set_callback(vregusb_dev, vregusb_event_cb, dev);
+	if (err) {
+		LOG_ERR("Failed to set regulator callback");
+		return err;
+	}
 
-	/* TODO: Determine conditions when VBUSDETECTED is not generated */
-	if (sys_read32((mem_addr_t)NRF_VREGUSB + 0x400) & BIT(2)) {
-		k_event_post(&usbhs_events, USBHS_VBUS_READY);
-		udc_submit_event(dev, UDC_EVT_VBUS_READY, 0);
+	err = regulator_enable(vregusb_dev);
+	if (err) {
+		LOG_ERR("Failed to enable regulator");
+		return err;
 	}
 
-	irq_enable(VREGUSB_IRQn);
 	pclk24m_mgr = z_nrf_clock_control_get_onoff(CLOCK_CONTROL_NRF_SUBSYS_HF24M);
 
 	return 0;
@@ -463,10 +466,9 @@ static inline int usbhs_disable_core(const struct device *dev)
 
 static inline int usbhs_disable_vreg(const struct device *dev)
 {
-	NRF_VREGUSB->INTEN = 0;
-	NRF_VREGUSB->TASKS_STOP = 1;
+	ARG_UNUSED(dev);
 
-	return 0;
+	return regulator_disable(vregusb_dev);
 }
 
 static inline int usbhs_init_caps(const struct device *dev)

dts/bindings/regulator/nordic,vregusb-regulator.yaml

@@ -0,0 +1,20 @@
+# Copyright Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+description: |
+  Nordic VBUS regulator for USB peripheral
+
+compatible: "nordic,vregusb-regulator"
+
+include:
+  - name: base.yaml
+  - name: regulator.yaml
+    property-allowlist:
+      - regulator-name
+
+properties:
+  reg:
+    required: true
+
+  regulator-name:
+    required: true

dts/bindings/usb/nordic,nrf-usbhs-wrapper.yaml

@@ -0,0 +1,18 @@
+description: |
+  Nordic wrapper for USB controller and PHY hardware. The wrapper is used to
+  configure, control, and enable/disable the USB PHY, and to enable/disable USB
+  controller.
+
+compatible: "nordic,nrf-usbhs-wrapper"
+
+include: [base.yaml]
+
+properties:
+  reg:
+    required: true
+
+  regulator:
+    required: true
+    type: phandle
+    description: |
+      USB PHY and controller function depends on the USB regulator VREGUSB.

dts/vendor/nordic/nrf54lm20_a_b.dtsi

@@ -239,17 +239,25 @@
 				prescaler = <0>;
 			};
 
-			usbhs: usbhs@5a000 {
-				compatible = "nordic,nrf-usbhs-nrf54l", "snps,dwc2";
-				reg = <0x5a000 0x1000>, <0x20000 0x1a000>;
-				reg-names = "wrapper", "core";
-				interrupts = <90 NRF_DEFAULT_IRQ_PRIORITY>;
-				num-in-eps = <16>;
-				num-out-eps = <16>;
-				ghwcfg1 = <0x0>;
-				ghwcfg2 = <0x22affc52>;
-				ghwcfg4 = <0x3e10aa60>;
-				status = "disabled";
+			usbhs_wrapper: usbhs_wrapper@5a000 {
+				compatible = "nordic,nrf-usbhs-wrapper";
+				reg = <0x5a000 0x1000>;
+				ranges = <0x20000 0x20000 0x1a000>;
+				#address-cells = <1>;
+				#size-cells = <1>;
+				regulator = <&vregusb>;
+
+				usbhs: usbhs@20000 {
+					compatible = "nordic,nrf-usbhs-nrf54l", "snps,dwc2";
+					reg = <0x20000 0x1a000>;
+					interrupts = <90 NRF_DEFAULT_IRQ_PRIORITY>;
+					num-in-eps = <16>;
+					num-out-eps = <16>;
+					ghwcfg1 = <0x0>;
+					ghwcfg2 = <0x22affc52>;
+					ghwcfg4 = <0x3e10aa60>;
+					status = "disabled";
+				};
 			};
 
 			dppic10: dppic@82000 {
@@ -859,18 +867,27 @@
 
 			regulators: regulator@120000 {
 				compatible = "nordic,nrf54l-regulators";
-				reg = <0x120000 0x1000>;
+				reg = <0x120000 0x2000>;
+				ranges = <0x0 0x120000 0x2000>;
 				status = "disabled";
 				#address-cells = <1>;
 				#size-cells = <1>;
 
-				vregmain: regulator@120600 {
+				vregmain: regulator@0 {
 					compatible = "nordic,nrf5x-regulator";
-					reg = <0x120600 0x1>;
+					reg = <0x0 0x1000>;
 					status = "disabled";
 					regulator-name = "VREGMAIN";
 					regulator-initial-mode = <NRF5X_REG_MODE_LDO>;
 				};
+
+				vregusb: regulator@1000 {
+					compatible = "nordic,vregusb-regulator";
+					reg = <0x1000 0x1000>;
+					status = "disabled";
+					regulator-name = "VREGUSB";
+					interrupts = <289 NRF_DEFAULT_IRQ_PRIORITY>;
+				};
 			};
 		};