xref: /freebsd/sys/dev/usb/controller/generic_xhci_fdt.c (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2015 Semihalf.
5  * Copyright (c) 2015 Stormshield.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 #include "opt_bus.h"
32 
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/bus.h>
36 #include <sys/condvar.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 
40 #include <dev/usb/usb.h>
41 #include <dev/usb/usbdi.h>
42 
43 #include <dev/usb/usb_core.h>
44 #include <dev/usb/usb_busdma.h>
45 #include <dev/usb/usb_process.h>
46 
47 #include <dev/usb/usb_controller.h>
48 #include <dev/usb/usb_bus.h>
49 #include <dev/usb/controller/xhci.h>
50 
51 #include <dev/ofw/ofw_bus.h>
52 #include <dev/ofw/ofw_bus_subr.h>
53 
54 #include <dev/extres/phy/phy.h>
55 
56 #include "generic_xhci.h"
57 
58 /* Flags for the OFW compat data table */
59 #define	XHCI_FDT_MATCH		0x01
60 #define	XHCI_FDT_32BIT_DMA	0x02	/* Controller needs 32-bit DMA */
61 
62 static struct ofw_compat_data compat_data[] = {
63 	{"marvell,armada-380-xhci",	XHCI_FDT_MATCH},
64 	{"marvell,armada3700-xhci",	XHCI_FDT_MATCH},
65 	{"marvell,armada-8k-xhci",	XHCI_FDT_MATCH},
66 	{"generic-xhci",		XHCI_FDT_MATCH},
67 	{NULL,				0}
68 };
69 
70 static int
71 generic_xhci_fdt_probe(device_t dev)
72 {
73 
74 	if (!ofw_bus_status_okay(dev))
75 		return (ENXIO);
76 
77 	if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
78 		return (ENXIO);
79 
80 	device_set_desc(dev, XHCI_HC_DEVSTR);
81 
82 	return (BUS_PROBE_DEFAULT);
83 }
84 
85 static int
86 generic_xhci_fdt_attach(device_t dev)
87 {
88 	struct xhci_softc *sc = device_get_softc(dev);
89 	phandle_t node;
90 	phy_t phy;
91 	int flags;
92 
93 	node = ofw_bus_get_node(dev);
94 	if (phy_get_by_ofw_property(dev, node, "usb-phy", &phy) == 0)
95 		if (phy_enable(phy) != 0)
96 			device_printf(dev, "Cannot enable phy\n");
97 
98 	flags = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
99 	if ((flags & XHCI_FDT_32BIT_DMA) != 0)
100 		sc->sc_quirks |= XHCI_QUIRK_DMA_32B;
101 
102 	return (generic_xhci_attach(dev));
103 }
104 
105 static int
106 generic_xhci_fdt_detach(device_t dev)
107 {
108 	phandle_t node;
109 	phy_t phy;
110 	int err;
111 
112 	err = generic_xhci_detach(dev);
113 	if (err != 0)
114 		return (err);
115 
116 	node = ofw_bus_get_node(dev);
117 	if (phy_get_by_ofw_property(dev, node, "usb-phy", &phy) == 0)
118 		phy_release(phy);
119 
120 	return (0);
121 }
122 
123 static device_method_t xhci_fdt_methods[] = {
124 	/* Device interface */
125 	DEVMETHOD(device_probe, generic_xhci_fdt_probe),
126 	DEVMETHOD(device_attach, generic_xhci_fdt_attach),
127 	DEVMETHOD(device_detach, generic_xhci_fdt_detach),
128 
129 	DEVMETHOD_END
130 };
131 
132 DEFINE_CLASS_1(xhci, xhci_fdt_driver, xhci_fdt_methods,
133     sizeof(struct xhci_softc), generic_xhci_driver);
134 
135 DRIVER_MODULE(xhci, simplebus, xhci_fdt_driver, 0, 0);
136 MODULE_DEPEND(xhci, usb, 1, 1, 1);
137