git: 29bfcb3a286f - main - arm64: xilinx: Add glue driver for usb3 controller

The branch main has been updated by manu:

URL: https://cgit.FreeBSD.org/src/commit/?id=29bfcb3a286fcf53ae6479f735d8ed49bd4a7c1f

commit 29bfcb3a286fcf53ae6479f735d8ed49bd4a7c1f
Author:     Emmanuel Vadot <manu@FreeBSD.org>
AuthorDate: 2023-08-23 06:58:03 +0000
Commit:     Emmanuel Vadot <manu@FreeBSD.org>
CommitDate: 2023-08-23 07:00:05 +0000

    arm64: xilinx: Add glue driver for usb3 controller
    
    Like other dwc3 controller, on Xilinx ZynqMP the base node is just here
    to provide resets, the main dwc3 controller node is a child node.
    
    Sponsored by:   Beckhoff Automation GmbH & Co. KG
---
 sys/conf/files.arm64               |   1 +
 sys/dev/usb/controller/xlnx_dwc3.c | 149 +++++++++++++++++++++++++++++++++++++
 2 files changed, 150 insertions(+)

diff --git a/sys/conf/files.arm64 b/sys/conf/files.arm64
index 2036bbe918ba..390d9e5db487 100644
--- a/sys/conf/files.arm64
+++ b/sys/conf/files.arm64
@@ -697,3 +697,4 @@ arm64/rockchip/clk/rk3568_pmucru.c		optional fdt soc_rockchip_rk3568
 # Xilinx
 arm/xilinx/uart_dev_cdnc.c			optional uart soc_xilinx_zynq fdt
 arm/xilinx/zy7_gpio.c				optional gpio soc_xilinx_zynq fdt
+dev/usb/controller/xlnx_dwc3.c			optional fdt xhci soc_xilinx_zynq fdt
diff --git a/sys/dev/usb/controller/xlnx_dwc3.c b/sys/dev/usb/controller/xlnx_dwc3.c
new file mode 100644
index 000000000000..aad929663eed
--- /dev/null
+++ b/sys/dev/usb/controller/xlnx_dwc3.c
@@ -0,0 +1,149 @@
+/*-
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (c) 2022 Beckhoff Automation GmbH & Co. KG
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/*
+ * Xilinx DWC3 glue
+ */
+
+#include <sys/cdefs.h>
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/bus.h>
+#include <sys/rman.h>
+#include <sys/kernel.h>
+#include <sys/module.h>
+#include <sys/gpio.h>
+#include <machine/bus.h>
+
+#include <dev/fdt/simplebus.h>
+
+#include <dev/fdt/fdt_common.h>
+#include <dev/ofw/ofw_bus.h>
+#include <dev/ofw/ofw_bus_subr.h>
+#include <dev/ofw/ofw_subr.h>
+
+#include <dev/extres/clk/clk.h>
+#include <dev/extres/hwreset/hwreset.h>
+#include <dev/extres/phy/phy_usb.h>
+#include <dev/extres/syscon/syscon.h>
+
+static struct ofw_compat_data compat_data[] = {
+	{ "xlnx,zynqmp-dwc3",	1 },
+	{ NULL,			0 }
+};
+
+struct xlnx_dwc3_softc {
+	struct simplebus_softc	sc;
+	device_t		dev;
+	hwreset_t		rst_crst;
+	hwreset_t		rst_hibrst;
+	hwreset_t		rst_apbrst;
+};
+
+static int
+xlnx_dwc3_probe(device_t dev)
+{
+	phandle_t node;
+
+	if (!ofw_bus_status_okay(dev))
+		return (ENXIO);
+
+	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
+		return (ENXIO);
+
+	/* Binding says that we need a child node for the actual dwc3 controller */
+	node = ofw_bus_get_node(dev);
+	if (OF_child(node) <= 0)
+		return (ENXIO);
+
+	device_set_desc(dev, "Xilinx ZYNQMP DWC3");
+	return (BUS_PROBE_DEFAULT);
+}
+
+static int
+xlnx_dwc3_attach(device_t dev)
+{
+	struct xlnx_dwc3_softc *sc;
+	device_t cdev;
+	phandle_t node, child;
+
+	sc = device_get_softc(dev);
+	sc->dev = dev;
+	node = ofw_bus_get_node(dev);
+
+	/*
+	 * Put module out of reset
+	 * Based on the bindings this should be mandatory to have
+	 * but reality shows that they aren't always there.
+	 * This is the case on the DTB in the AVnet Ultra96
+	 */
+	if (hwreset_get_by_ofw_name(dev, node, "usb_crst", &sc->rst_crst) == 0) {
+		if (hwreset_deassert(sc->rst_crst) != 0) {
+			device_printf(dev, "Cannot deassert reset\n");
+			return (ENXIO);
+		}
+	}
+	if (hwreset_get_by_ofw_name(dev, node, "usb_hibrst", &sc->rst_hibrst) == 0) {
+		if (hwreset_deassert(sc->rst_crst) != 0) {
+			device_printf(dev, "Cannot deassert reset\n");
+			return (ENXIO);
+		}
+	}
+	if (hwreset_get_by_ofw_name(dev, node, "usb_apbrst", &sc->rst_apbrst) == 0) {
+		if (hwreset_deassert(sc->rst_crst) != 0) {
+			device_printf(dev, "Cannot deassert reset\n");
+			return (ENXIO);
+		}
+	}
+
+	simplebus_init(dev, node);
+	if (simplebus_fill_ranges(node, &sc->sc) < 0) {
+		device_printf(dev, "could not get ranges\n");
+		return (ENXIO);
+	}
+
+	for (child = OF_child(node); child > 0; child = OF_peer(child)) {
+		cdev = simplebus_add_device(dev, child, 0, NULL, -1, NULL);
+		if (cdev != NULL)
+			device_probe_and_attach(cdev);
+	}
+
+	return (bus_generic_attach(dev));
+}
+
+static device_method_t xlnx_dwc3_methods[] = {
+	/* Device interface */
+	DEVMETHOD(device_probe,		xlnx_dwc3_probe),
+	DEVMETHOD(device_attach,	xlnx_dwc3_attach),
+
+	DEVMETHOD_END
+};
+
+DEFINE_CLASS_1(xlnx_dwc3, xlnx_dwc3_driver, xlnx_dwc3_methods,
+    sizeof(struct xlnx_dwc3_softc), simplebus_driver);
+DRIVER_MODULE(xlnx_dwc3, simplebus, xlnx_dwc3_driver, 0, 0);