1 /*- 2 * Copyright (C) 2008 MARVELL INTERNATIONAL LTD. 3 * All rights reserved. 4 * 5 * Developed by Semihalf. 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 * 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. 18 * 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 29 * SUCH DAMAGE. 30 */ 31 32 /* 33 * FDT attachment driver for the USB Enhanced Host Controller. 34 */ 35 36 #include <sys/cdefs.h> 37 __FBSDID("$FreeBSD$"); 38 39 #include "opt_bus.h" 40 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> 48 #include <sys/bus.h> 49 #include <sys/module.h> 50 #include <sys/lock.h> 51 #include <sys/mutex.h> 52 #include <sys/condvar.h> 53 #include <sys/sysctl.h> 54 #include <sys/sx.h> 55 #include <sys/unistd.h> 56 #include <sys/callout.h> 57 #include <sys/malloc.h> 58 #include <sys/priv.h> 59 60 #include <dev/ofw/ofw_bus.h> 61 #include <dev/ofw/ofw_bus_subr.h> 62 63 #include <dev/usb/usb.h> 64 #include <dev/usb/usbdi.h> 65 66 #include <dev/usb/usb_core.h> 67 #include <dev/usb/usb_busdma.h> 68 #include <dev/usb/usb_process.h> 69 #include <dev/usb/usb_util.h> 70 71 #include <dev/usb/usb_controller.h> 72 #include <dev/usb/usb_bus.h> 73 #include <dev/usb/controller/ehci.h> 74 #include <dev/usb/controller/ehcireg.h> 75 76 #include <arm/mv/mvreg.h> 77 #include <arm/mv/mvvar.h> 78 79 #define EHCI_VENDORID_MRVL 0x1286 80 #define EHCI_HC_DEVSTR "Marvell Integrated USB 2.0 controller" 81 82 static device_attach_t mv_ehci_attach; 83 static device_detach_t mv_ehci_detach; 84 85 static int err_intr(void *arg); 86 87 static struct resource *irq_err; 88 static void *ih_err; 89 90 /* EHCI HC regs start at this offset within USB range */ 91 #define MV_USB_HOST_OFST 0x0100 92 93 #define USB_BRIDGE_INTR_CAUSE 0x210 94 #define USB_BRIDGE_INTR_MASK 0x214 95 #define USB_BRIDGE_ERR_ADDR 0x21C 96 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) 101 102 static int 103 mv_ehci_probe(device_t self) 104 { 105 106 if (!ofw_bus_is_compatible(self, "mrvl,usb-ehci")) 107 return (ENXIO); 108 109 device_set_desc(self, EHCI_HC_DEVSTR); 110 111 return (BUS_PROBE_DEFAULT); 112 } 113 114 static int 115 mv_ehci_attach(device_t self) 116 { 117 ehci_softc_t *sc = device_get_softc(self); 118 bus_space_handle_t bsh; 119 int err; 120 int rid; 121 122 /* initialise some bus fields */ 123 sc->sc_bus.parent = self; 124 sc->sc_bus.devices = sc->sc_devices; 125 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 126 127 /* get all DMA memory */ 128 if (usb_bus_mem_alloc_all(&sc->sc_bus, 129 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 130 return (ENOMEM); 131 } 132 133 rid = 0; 134 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 135 if (!sc->sc_io_res) { 136 device_printf(self, "Could not map memory\n"); 137 goto error; 138 } 139 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 140 bsh = rman_get_bushandle(sc->sc_io_res); 141 sc->sc_io_size = rman_get_size(sc->sc_io_res) - MV_USB_HOST_OFST; 142 143 /* 144 * Marvell EHCI host controller registers start at certain offset 145 * within the whole USB registers range, so create a subregion for the 146 * host mode configuration purposes. 147 */ 148 149 if (bus_space_subregion(sc->sc_io_tag, bsh, MV_USB_HOST_OFST, 150 sc->sc_io_size, &sc->sc_io_hdl) != 0) 151 panic("%s: unable to subregion USB host registers", 152 device_get_name(self)); 153 154 rid = 0; 155 irq_err = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 156 RF_SHAREABLE | RF_ACTIVE); 157 if (irq_err == NULL) { 158 device_printf(self, "Could not allocate error irq\n"); 159 mv_ehci_detach(self); 160 return (ENXIO); 161 } 162 163 /* 164 * Notice: Marvell EHCI controller has TWO interrupt lines, so make 165 * sure to use the correct rid for the main one (controller interrupt) 166 * -- refer to DTS for the right resource number to use here. 167 */ 168 rid = 1; 169 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 170 RF_SHAREABLE | RF_ACTIVE); 171 if (sc->sc_irq_res == NULL) { 172 device_printf(self, "Could not allocate irq\n"); 173 goto error; 174 } 175 176 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 177 if (!sc->sc_bus.bdev) { 178 device_printf(self, "Could not add USB device\n"); 179 goto error; 180 } 181 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 182 device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR); 183 184 sprintf(sc->sc_vendor, "Marvell"); 185 186 err = bus_setup_intr(self, irq_err, INTR_TYPE_BIO, 187 err_intr, NULL, sc, &ih_err); 188 if (err) { 189 device_printf(self, "Could not setup error irq, %d\n", err); 190 ih_err = NULL; 191 goto error; 192 } 193 194 EWRITE4(sc, USB_BRIDGE_INTR_MASK, MV_USB_ADDR_DECODE_ERR | 195 MV_USB_HOST_UNDERFLOW | MV_USB_HOST_OVERFLOW | 196 MV_USB_DEVICE_UNDERFLOW); 197 198 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 199 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 200 if (err) { 201 device_printf(self, "Could not setup irq, %d\n", err); 202 sc->sc_intr_hdl = NULL; 203 goto error; 204 } 205 206 /* 207 * Workaround for Marvell integrated EHCI controller: reset of 208 * the EHCI core clears the USBMODE register, which sets the core in 209 * an undefined state (neither host nor agent), so it needs to be set 210 * again for proper operation. 211 * 212 * Refer to errata document MV-S500832-00D.pdf (p. 5.24 GL USB-2) for 213 * details. 214 */ 215 sc->sc_flags |= EHCI_SCFLG_SETMODE; 216 if (bootverbose) 217 device_printf(self, "5.24 GL USB-2 workaround enabled\n"); 218 219 /* XXX all MV chips need it? */ 220 sc->sc_flags |= EHCI_SCFLG_FORCESPEED | EHCI_SCFLG_NORESTERM; 221 222 err = ehci_init(sc); 223 if (!err) { 224 err = device_probe_and_attach(sc->sc_bus.bdev); 225 } 226 if (err) { 227 device_printf(self, "USB init failed err=%d\n", err); 228 goto error; 229 } 230 return (0); 231 232 error: 233 mv_ehci_detach(self); 234 return (ENXIO); 235 } 236 237 static int 238 mv_ehci_detach(device_t self) 239 { 240 ehci_softc_t *sc = device_get_softc(self); 241 device_t bdev; 242 int err; 243 244 if (sc->sc_bus.bdev) { 245 bdev = sc->sc_bus.bdev; 246 device_detach(bdev); 247 device_delete_child(self, bdev); 248 } 249 /* during module unload there are lots of children leftover */ 250 device_delete_children(self); 251 252 /* 253 * disable interrupts that might have been switched on in mv_ehci_attach 254 */ 255 if (sc->sc_io_res) { 256 EWRITE4(sc, USB_BRIDGE_INTR_MASK, 0); 257 } 258 if (sc->sc_irq_res && sc->sc_intr_hdl) { 259 /* 260 * only call ehci_detach() after ehci_init() 261 */ 262 ehci_detach(sc); 263 264 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 265 266 if (err) 267 /* XXX or should we panic? */ 268 device_printf(self, "Could not tear down irq, %d\n", 269 err); 270 sc->sc_intr_hdl = NULL; 271 } 272 if (irq_err && ih_err) { 273 err = bus_teardown_intr(self, irq_err, ih_err); 274 275 if (err) 276 device_printf(self, "Could not tear down irq, %d\n", 277 err); 278 ih_err = NULL; 279 } 280 if (irq_err) { 281 bus_release_resource(self, SYS_RES_IRQ, 0, irq_err); 282 irq_err = NULL; 283 } 284 if (sc->sc_irq_res) { 285 bus_release_resource(self, SYS_RES_IRQ, 1, sc->sc_irq_res); 286 sc->sc_irq_res = NULL; 287 } 288 if (sc->sc_io_res) { 289 bus_release_resource(self, SYS_RES_MEMORY, 0, 290 sc->sc_io_res); 291 sc->sc_io_res = NULL; 292 } 293 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 294 295 return (0); 296 } 297 298 static int 299 err_intr(void *arg) 300 { 301 ehci_softc_t *sc = arg; 302 unsigned int cause; 303 304 cause = EREAD4(sc, USB_BRIDGE_INTR_CAUSE); 305 if (cause) { 306 printf("USB error: "); 307 if (cause & MV_USB_ADDR_DECODE_ERR) { 308 uint32_t addr; 309 310 addr = EREAD4(sc, USB_BRIDGE_ERR_ADDR); 311 printf("address decoding error (addr=%#x)\n", addr); 312 } 313 if (cause & MV_USB_HOST_UNDERFLOW) 314 printf("host underflow\n"); 315 if (cause & MV_USB_HOST_OVERFLOW) 316 printf("host overflow\n"); 317 if (cause & MV_USB_DEVICE_UNDERFLOW) 318 printf("device underflow\n"); 319 if (cause & ~(MV_USB_ADDR_DECODE_ERR | MV_USB_HOST_UNDERFLOW | 320 MV_USB_HOST_OVERFLOW | MV_USB_DEVICE_UNDERFLOW)) 321 printf("unknown cause (cause=%#x)\n", cause); 322 323 EWRITE4(sc, USB_BRIDGE_INTR_CAUSE, 0); 324 } 325 return (FILTER_HANDLED); 326 } 327 328 static device_method_t ehci_methods[] = { 329 /* Device interface */ 330 DEVMETHOD(device_probe, mv_ehci_probe), 331 DEVMETHOD(device_attach, mv_ehci_attach), 332 DEVMETHOD(device_detach, mv_ehci_detach), 333 DEVMETHOD(device_suspend, bus_generic_suspend), 334 DEVMETHOD(device_resume, bus_generic_resume), 335 DEVMETHOD(device_shutdown, bus_generic_shutdown), 336 337 DEVMETHOD_END 338 }; 339 340 static driver_t ehci_driver = { 341 "ehci", 342 ehci_methods, 343 sizeof(ehci_softc_t), 344 }; 345 346 static devclass_t ehci_devclass; 347 348 DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0); 349 MODULE_DEPEND(ehci, usb, 1, 1, 1); 350