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 <sys/stdint.h>
32 #include <sys/stddef.h>
33 #include <sys/param.h>
34 #include <sys/queue.h>
35 #include <sys/types.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/bus.h>
39 #include <sys/module.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/condvar.h>
43 #include <sys/sysctl.h>
44 #include <sys/sx.h>
45 #include <sys/unistd.h>
46 #include <sys/priv.h>
47 #include <sys/rman.h>
48
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51
52 #include <dev/usb/usb_core.h>
53 #include <dev/usb/usb_busdma.h>
54 #include <dev/usb/usb_process.h>
55 #include <dev/usb/usb_util.h>
56
57 #include <dev/usb/usb_controller.h>
58 #include <dev/usb/usb_bus.h>
59 #include <dev/usb/controller/xhci.h>
60 #include <dev/usb/controller/xhcireg.h>
61
62 #include "generic_xhci.h"
63
64 #if __SIZEOF_LONG__ == 8
65 #define IS_DMA_32B 0
66 #elif __SIZEOF_LONG__ == 4
67 #define IS_DMA_32B 1
68 #else
69 #error unsupported long size
70 #endif
71
72 int
generic_xhci_attach(device_t dev)73 generic_xhci_attach(device_t dev)
74 {
75 struct xhci_softc *sc = device_get_softc(dev);
76 int err = 0, rid = 0;
77
78 sc->sc_bus.parent = dev;
79 sc->sc_bus.devices = sc->sc_devices;
80 sc->sc_bus.devices_max = XHCI_MAX_DEVICES;
81
82 sc->sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
83 RF_ACTIVE);
84 if (sc->sc_io_res == NULL) {
85 device_printf(dev, "Failed to map memory\n");
86 generic_xhci_detach(dev);
87 return (ENXIO);
88 }
89
90 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
91 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
92 sc->sc_io_size = rman_get_size(sc->sc_io_res);
93
94 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
95 RF_SHAREABLE | RF_ACTIVE);
96 if (sc->sc_irq_res == NULL) {
97 device_printf(dev, "Failed to allocate IRQ\n");
98 generic_xhci_detach(dev);
99 return (ENXIO);
100 }
101
102 sc->sc_bus.bdev = device_add_child(dev, "usbus", DEVICE_UNIT_ANY);
103 if (sc->sc_bus.bdev == NULL) {
104 device_printf(dev, "Failed to add USB device\n");
105 generic_xhci_detach(dev);
106 return (ENXIO);
107 }
108
109 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
110
111 sprintf(sc->sc_vendor, XHCI_HC_VENDOR);
112 device_set_desc(sc->sc_bus.bdev, XHCI_HC_DEVSTR);
113
114 err = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
115 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
116 if (err != 0) {
117 device_printf(dev, "Failed to setup error IRQ, %d\n", err);
118 sc->sc_intr_hdl = NULL;
119 generic_xhci_detach(dev);
120 return (err);
121 }
122
123 err = xhci_init(sc, dev,
124 (sc->sc_quirks & XHCI_QUIRK_DMA_32B) == 0 ? IS_DMA_32B : 1);
125 if (err != 0) {
126 device_printf(dev, "Failed to init XHCI, with error %d\n", err);
127 generic_xhci_detach(dev);
128 return (ENXIO);
129 }
130
131 err = xhci_start_controller(sc);
132 if (err != 0) {
133 device_printf(dev, "Failed to start XHCI controller, with error %d\n", err);
134 generic_xhci_detach(dev);
135 return (ENXIO);
136 }
137
138 err = device_probe_and_attach(sc->sc_bus.bdev);
139 if (err != 0) {
140 device_printf(dev, "Failed to initialize USB, with error %d\n", err);
141 generic_xhci_detach(dev);
142 return (ENXIO);
143 }
144
145 return (0);
146 }
147
148 int
generic_xhci_detach(device_t dev)149 generic_xhci_detach(device_t dev)
150 {
151 struct xhci_softc *sc = device_get_softc(dev);
152 int err;
153
154 /* during module unload there are lots of children leftover */
155 err = bus_generic_detach(dev);
156 if (err != 0)
157 return (err);
158
159 if (sc->sc_irq_res != NULL && sc->sc_intr_hdl != NULL) {
160 err = bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr_hdl);
161 if (err != 0)
162 device_printf(dev, "Could not tear down irq, %d\n",
163 err);
164 sc->sc_intr_hdl = NULL;
165 }
166
167 if (sc->sc_irq_res != NULL) {
168 bus_release_resource(dev, SYS_RES_IRQ,
169 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res);
170 sc->sc_irq_res = NULL;
171 }
172
173 if (sc->sc_io_res != NULL) {
174 bus_release_resource(dev, SYS_RES_MEMORY,
175 rman_get_rid(sc->sc_io_res), sc->sc_io_res);
176 sc->sc_io_res = NULL;
177 }
178
179 xhci_uninit(sc);
180
181 return (0);
182 }
183
184 static device_method_t xhci_methods[] = {
185 /* Device interface */
186 DEVMETHOD(device_attach, generic_xhci_attach),
187 DEVMETHOD(device_detach, generic_xhci_detach),
188 DEVMETHOD(device_suspend, bus_generic_suspend),
189 DEVMETHOD(device_resume, bus_generic_resume),
190 DEVMETHOD(device_shutdown, bus_generic_shutdown),
191
192 DEVMETHOD_END
193 };
194
195 driver_t generic_xhci_driver = {
196 "xhci",
197 xhci_methods,
198 sizeof(struct xhci_softc),
199 };
200