2 * Copyright (C) 2008 MARVELL INTERNATIONAL LTD.
5 * Developed by Semihalf.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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 * 3. Neither the name of MARVELL nor the names of contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * MBus attachment driver for the USB Enhanced Host Controller.
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
41 #include <sys/stdint.h>
42 #include <sys/stddef.h>
43 #include <sys/param.h>
44 #include <sys/queue.h>
45 #include <sys/types.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
49 #include <sys/linker_set.h>
50 #include <sys/module.h>
52 #include <sys/mutex.h>
53 #include <sys/condvar.h>
54 #include <sys/sysctl.h>
56 #include <sys/unistd.h>
57 #include <sys/callout.h>
58 #include <sys/malloc.h>
61 #include <dev/usb/usb.h>
62 #include <dev/usb/usbdi.h>
64 #include <dev/usb/usb_core.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_process.h>
67 #include <dev/usb/usb_util.h>
69 #include <dev/usb/usb_controller.h>
70 #include <dev/usb/usb_bus.h>
71 #include <dev/usb/controller/ehci.h>
72 #include <dev/usb/controller/ehcireg.h>
74 #include <arm/mv/mvreg.h>
75 #include <arm/mv/mvvar.h>
77 #define EHCI_VENDORID_MRVL 0x1286
78 #define EHCI_HC_DEVSTR "Marvell Integrated USB 2.0 controller"
80 static device_attach_t ehci_mbus_attach;
81 static device_detach_t ehci_mbus_detach;
82 static device_shutdown_t ehci_mbus_shutdown;
83 static device_suspend_t ehci_mbus_suspend;
84 static device_resume_t ehci_mbus_resume;
86 static int err_intr(void *arg);
88 static struct resource *irq_err;
91 /* EHCI HC regs start at this offset within USB range */
92 #define MV_USB_HOST_OFST 0x0100
94 #define USB_BRIDGE_INTR_CAUSE 0x210
95 #define USB_BRIDGE_INTR_MASK 0x214
97 #define MV_USB_ADDR_DECODE_ERR (1 << 0)
98 #define MV_USB_HOST_UNDERFLOW (1 << 1)
99 #define MV_USB_HOST_OVERFLOW (1 << 2)
100 #define MV_USB_DEVICE_UNDERFLOW (1 << 3)
103 ehci_mbus_suspend(device_t self)
105 ehci_softc_t *sc = device_get_softc(self);
108 err = bus_generic_suspend(self);
116 ehci_mbus_resume(device_t self)
118 ehci_softc_t *sc = device_get_softc(self);
122 bus_generic_resume(self);
128 ehci_mbus_shutdown(device_t self)
130 ehci_softc_t *sc = device_get_softc(self);
133 err = bus_generic_shutdown(self);
142 ehci_mbus_probe(device_t self)
145 device_set_desc(self, EHCI_HC_DEVSTR);
147 return (BUS_PROBE_DEFAULT);
151 ehci_mbus_attach(device_t self)
153 ehci_softc_t *sc = device_get_softc(self);
154 bus_space_handle_t bsh;
158 /* initialise some bus fields */
159 sc->sc_bus.parent = self;
160 sc->sc_bus.devices = sc->sc_devices;
161 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
163 /* get all DMA memory */
164 if (usb_bus_mem_alloc_all(&sc->sc_bus,
165 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
170 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
171 if (!sc->sc_io_res) {
172 device_printf(self, "Could not map memory\n");
175 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
176 bsh = rman_get_bushandle(sc->sc_io_res);
177 sc->sc_io_size = rman_get_size(sc->sc_io_res) - MV_USB_HOST_OFST;
180 * Marvell EHCI host controller registers start at certain offset within
181 * the whole USB registers range, so create a subregion for the host
182 * mode configuration purposes.
184 if (bus_space_subregion(sc->sc_io_tag, bsh, MV_USB_HOST_OFST,
185 sc->sc_io_size, &sc->sc_io_hdl) != 0)
186 panic("%s: unable to subregion USB host registers",
187 device_get_name(self));
190 irq_err = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
191 RF_SHAREABLE | RF_ACTIVE);
192 if (irq_err == NULL) {
193 device_printf(self, "Could not allocate error irq\n");
194 ehci_mbus_detach(self);
199 * Notice: Marvell EHCI controller has TWO interrupt lines, so make sure to
200 * use the correct rid for the main one (controller interrupt) --
201 * refer to obio_devices[] for the right resource number to use here.
204 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
205 RF_SHAREABLE | RF_ACTIVE);
206 if (sc->sc_irq_res == NULL) {
207 device_printf(self, "Could not allocate irq\n");
211 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
212 if (!sc->sc_bus.bdev) {
213 device_printf(self, "Could not add USB device\n");
216 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
217 device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
219 sprintf(sc->sc_vendor, "Marvell");
221 err = bus_setup_intr(self, irq_err, INTR_FAST | INTR_TYPE_BIO,
222 err_intr, NULL, sc, &ih_err);
224 device_printf(self, "Could not setup error irq, %d\n", err);
229 EWRITE4(sc, USB_BRIDGE_INTR_MASK, MV_USB_ADDR_DECODE_ERR |
230 MV_USB_HOST_UNDERFLOW | MV_USB_HOST_OVERFLOW |
231 MV_USB_DEVICE_UNDERFLOW);
233 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
234 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
236 device_printf(self, "Could not setup irq, %d\n", err);
237 sc->sc_intr_hdl = NULL;
242 * Workaround for Marvell integrated EHCI controller: reset of
243 * the EHCI core clears the USBMODE register, which sets the core in
244 * an undefined state (neither host nor agent), so it needs to be set
245 * again for proper operation.
247 * Refer to errata document MV-S500832-00D.pdf (p. 5.24 GL USB-2) for
250 sc->sc_flags |= EHCI_SCFLG_SETMODE;
252 device_printf(self, "5.24 GL USB-2 workaround enabled\n");
254 /* XXX all MV chips need it? */
255 sc->sc_flags |= EHCI_SCFLG_FORCESPEED | EHCI_SCFLG_NORESTERM;
259 err = device_probe_and_attach(sc->sc_bus.bdev);
262 device_printf(self, "USB init failed err=%d\n", err);
268 ehci_mbus_detach(self);
273 ehci_mbus_detach(device_t self)
275 ehci_softc_t *sc = device_get_softc(self);
279 if (sc->sc_bus.bdev) {
280 bdev = sc->sc_bus.bdev;
282 device_delete_child(self, bdev);
284 /* during module unload there are lots of children leftover */
285 device_delete_all_children(self);
288 * disable interrupts that might have been switched on in ehci_init
291 EWRITE4(sc, EHCI_USBINTR, 0);
292 EWRITE4(sc, USB_BRIDGE_INTR_MASK, 0);
294 if (sc->sc_irq_res && sc->sc_intr_hdl) {
296 * only call ehci_detach() after ehci_init()
300 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
303 /* XXX or should we panic? */
304 device_printf(self, "Could not tear down irq, %d\n",
306 sc->sc_intr_hdl = NULL;
308 if (irq_err && ih_err) {
309 err = bus_teardown_intr(self, irq_err, ih_err);
312 device_printf(self, "Could not tear down irq, %d\n",
317 bus_release_resource(self, SYS_RES_IRQ, 0, irq_err);
320 if (sc->sc_irq_res) {
321 bus_release_resource(self, SYS_RES_IRQ, 1, sc->sc_irq_res);
322 sc->sc_irq_res = NULL;
325 bus_release_resource(self, SYS_RES_MEMORY, 0,
327 sc->sc_io_res = NULL;
329 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
337 ehci_softc_t *sc = arg;
340 cause = EREAD4(sc, USB_BRIDGE_INTR_CAUSE);
342 printf("IRQ ERR: cause: 0x%08x\n", cause);
343 if (cause & MV_USB_ADDR_DECODE_ERR)
344 printf("IRQ ERR: Address decoding error\n");
345 if (cause & MV_USB_HOST_UNDERFLOW)
346 printf("IRQ ERR: USB Host Underflow\n");
347 if (cause & MV_USB_HOST_OVERFLOW)
348 printf("IRQ ERR: USB Host Overflow\n");
349 if (cause & MV_USB_DEVICE_UNDERFLOW)
350 printf("IRQ ERR: USB Device Underflow\n");
351 if (cause & ~(MV_USB_ADDR_DECODE_ERR | MV_USB_HOST_UNDERFLOW |
352 MV_USB_HOST_OVERFLOW | MV_USB_DEVICE_UNDERFLOW))
353 printf("IRQ ERR: Unknown error\n");
355 EWRITE4(sc, USB_BRIDGE_INTR_CAUSE, 0);
357 return (FILTER_HANDLED);
360 static device_method_t ehci_methods[] = {
361 /* Device interface */
362 DEVMETHOD(device_probe, ehci_mbus_probe),
363 DEVMETHOD(device_attach, ehci_mbus_attach),
364 DEVMETHOD(device_detach, ehci_mbus_detach),
365 DEVMETHOD(device_suspend, ehci_mbus_suspend),
366 DEVMETHOD(device_resume, ehci_mbus_resume),
367 DEVMETHOD(device_shutdown, ehci_mbus_shutdown),
370 DEVMETHOD(bus_print_child, bus_generic_print_child),
375 static driver_t ehci_driver = {
378 sizeof(ehci_softc_t),
381 static devclass_t ehci_devclass;
383 DRIVER_MODULE(ehci, mbus, ehci_driver, ehci_devclass, 0, 0);
384 MODULE_DEPEND(ehci, usb, 1, 1, 1);