1 #include <sys/cdefs.h>
2 __FBSDID("$FreeBSD: stable/10/sys/mips/cavium/usb/octusb_octeon.c 308402 2016-11-07 09:19:04Z hselasky $");
3 
4 /*-
5  * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/stdint.h>
30 #include <sys/stddef.h>
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/types.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/bus.h>
37 #include <sys/module.h>
38 #include <sys/lock.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/sysctl.h>
42 #include <sys/sx.h>
43 #include <sys/unistd.h>
44 #include <sys/callout.h>
45 #include <sys/malloc.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 
60 #include <contrib/octeon-sdk/cvmx.h>
61 #include <mips/cavium/octeon_irq.h>
62 #include <contrib/octeon-sdk/cvmx-usb.h>
63 
64 #include <mips/cavium/usb/octusb.h>
65 
66 #define	MEM_RID	0
67 
68 static device_identify_t octusb_octeon_identify;
69 static device_probe_t octusb_octeon_probe;
70 static device_attach_t octusb_octeon_attach;
71 static device_detach_t octusb_octeon_detach;
72 
73 struct octusb_octeon_softc {
74 	struct octusb_softc sc_dci;	/* must be first */
75 };
76 
77 static void
octusb_octeon_identify(driver_t * drv,device_t parent)78 octusb_octeon_identify(driver_t *drv, device_t parent)
79 {
80 	if (octeon_has_feature(OCTEON_FEATURE_USB))
81 		BUS_ADD_CHILD(parent, 0, "octusb", 0);
82 }
83 
84 static int
octusb_octeon_probe(device_t dev)85 octusb_octeon_probe(device_t dev)
86 {
87 	device_set_desc(dev, "Cavium Octeon USB controller");
88 	return (0);
89 }
90 
91 static int
octusb_octeon_attach(device_t dev)92 octusb_octeon_attach(device_t dev)
93 {
94 	struct octusb_octeon_softc *sc = device_get_softc(dev);
95 	int err;
96 	int rid;
97 	int nports;
98 	int i;
99 
100 	/* setup controller interface softc */
101 
102 	/* initialise some bus fields */
103 	sc->sc_dci.sc_bus.parent = dev;
104 	sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
105 	sc->sc_dci.sc_bus.devices_max = OCTUSB_MAX_DEVICES;
106 	sc->sc_dci.sc_bus.dma_bits = 32;
107 
108 	/* get all DMA memory */
109 	if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
110 	    USB_GET_DMA_TAG(dev), NULL)) {
111 		return (ENOMEM);
112 	}
113 	nports = cvmx_usb_get_num_ports();
114 	if (nports > OCTUSB_MAX_PORTS)
115 		panic("octusb: too many USB ports %d", nports);
116 	for (i = 0; i < nports; i++) {
117 		rid = 0;
118 		sc->sc_dci.sc_irq_res[i] =
119 		    bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
120 			       OCTEON_IRQ_USB0 + i, OCTEON_IRQ_USB0 + i, 1, RF_ACTIVE);
121 		if (!(sc->sc_dci.sc_irq_res[i])) {
122 			goto error;
123 		}
124 
125 #if (__FreeBSD_version >= 700031)
126 		err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res[i], INTR_TYPE_BIO | INTR_MPSAFE,
127 		    NULL, (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl[i]);
128 #else
129 		err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res[i], INTR_TYPE_BIO | INTR_MPSAFE,
130 		    (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl[i]);
131 #endif
132 		if (err) {
133 			sc->sc_dci.sc_intr_hdl[i] = NULL;
134 			goto error;
135 		}
136 	}
137 
138 	sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
139 	if (!(sc->sc_dci.sc_bus.bdev)) {
140 		goto error;
141 	}
142 	device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
143 
144 
145 	err = octusb_init(&sc->sc_dci);
146 	if (!err) {
147 		err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
148 	}
149 	if (err) {
150 		goto error;
151 	}
152 	return (0);
153 
154 error:
155 	octusb_octeon_detach(dev);
156 	return (ENXIO);
157 }
158 
159 static int
octusb_octeon_detach(device_t dev)160 octusb_octeon_detach(device_t dev)
161 {
162 	struct octusb_octeon_softc *sc = device_get_softc(dev);
163 	int err;
164 	int nports;
165 	int i;
166 
167 	/* during module unload there are lots of children leftover */
168 	device_delete_children(dev);
169 
170 	if (sc->sc_dci.sc_irq_res[0] && sc->sc_dci.sc_intr_hdl[0])
171 		/*
172 	 	 * only call octusb_octeon_uninit() after octusb_octeon_init()
173 	 	 */
174 		octusb_uninit(&sc->sc_dci);
175 
176 	nports = cvmx_usb_get_num_ports();
177 	if (nports > OCTUSB_MAX_PORTS)
178 		panic("octusb: too many USB ports %d", nports);
179 	for (i = 0; i < nports; i++) {
180 		if (sc->sc_dci.sc_irq_res[0] && sc->sc_dci.sc_intr_hdl[0]) {
181 			err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res[i],
182 			    sc->sc_dci.sc_intr_hdl[i]);
183 			sc->sc_dci.sc_intr_hdl[i] = NULL;
184 		}
185 		if (sc->sc_dci.sc_irq_res) {
186 			bus_release_resource(dev, SYS_RES_IRQ, 0,
187 			    sc->sc_dci.sc_irq_res[i]);
188 			sc->sc_dci.sc_irq_res[i] = NULL;
189 		}
190 	}
191 	usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
192 
193 	return (0);
194 }
195 
196 static device_method_t octusb_octeon_methods[] = {
197 	/* Device interface */
198 	DEVMETHOD(device_identify, octusb_octeon_identify),
199 	DEVMETHOD(device_probe, octusb_octeon_probe),
200 	DEVMETHOD(device_attach, octusb_octeon_attach),
201 	DEVMETHOD(device_detach, octusb_octeon_detach),
202 	DEVMETHOD(device_resume, bus_generic_resume),
203 	DEVMETHOD(device_suspend, bus_generic_suspend),
204 	DEVMETHOD(device_shutdown, bus_generic_shutdown),
205 
206 	DEVMETHOD_END
207 };
208 
209 static driver_t octusb_octeon_driver = {
210 	.name = "octusb",
211 	.methods = octusb_octeon_methods,
212 	.size = sizeof(struct octusb_octeon_softc),
213 };
214 
215 static devclass_t octusb_octeon_devclass;
216 
217 DRIVER_MODULE(octusb, ciu, octusb_octeon_driver, octusb_octeon_devclass, 0, 0);
218