1209131Sraj/*- 2209131Sraj * Copyright (C) 2008 MARVELL INTERNATIONAL LTD. 3209131Sraj * All rights reserved. 4209131Sraj * 5209131Sraj * Developed by Semihalf. 6209131Sraj * 7209131Sraj * Redistribution and use in source and binary forms, with or without 8209131Sraj * modification, are permitted provided that the following conditions 9209131Sraj * are met: 10209131Sraj * 1. Redistributions of source code must retain the above copyright 11209131Sraj * notice, this list of conditions and the following disclaimer. 12209131Sraj * 2. Redistributions in binary form must reproduce the above copyright 13209131Sraj * notice, this list of conditions and the following disclaimer in the 14209131Sraj * documentation and/or other materials provided with the distribution. 15209131Sraj * 3. Neither the name of MARVELL nor the names of contributors 16209131Sraj * may be used to endorse or promote products derived from this software 17209131Sraj * without specific prior written permission. 18209131Sraj * 19209131Sraj * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20209131Sraj * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21209131Sraj * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22209131Sraj * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 23209131Sraj * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24209131Sraj * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25209131Sraj * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26209131Sraj * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27209131Sraj * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28209131Sraj * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29209131Sraj * SUCH DAMAGE. 30209131Sraj */ 31209131Sraj 32209131Sraj/* 33209131Sraj * FDT attachment driver for the USB Enhanced Host Controller. 34209131Sraj */ 35209131Sraj 36209131Sraj#include <sys/cdefs.h> 37209131Sraj__FBSDID("$FreeBSD: releng/11.0/sys/dev/usb/controller/ehci_mv.c 294989 2016-01-28 14:11:59Z mmel $"); 38209131Sraj 39209131Sraj#include "opt_bus.h" 40209131Sraj 41209131Sraj#include <sys/stdint.h> 42209131Sraj#include <sys/stddef.h> 43209131Sraj#include <sys/param.h> 44209131Sraj#include <sys/queue.h> 45209131Sraj#include <sys/types.h> 46209131Sraj#include <sys/systm.h> 47209131Sraj#include <sys/kernel.h> 48209131Sraj#include <sys/bus.h> 49209131Sraj#include <sys/module.h> 50209131Sraj#include <sys/lock.h> 51209131Sraj#include <sys/mutex.h> 52209131Sraj#include <sys/condvar.h> 53209131Sraj#include <sys/sysctl.h> 54209131Sraj#include <sys/sx.h> 55209131Sraj#include <sys/unistd.h> 56209131Sraj#include <sys/callout.h> 57209131Sraj#include <sys/malloc.h> 58209131Sraj#include <sys/priv.h> 59209131Sraj 60209131Sraj#include <dev/ofw/ofw_bus.h> 61209131Sraj#include <dev/ofw/ofw_bus_subr.h> 62209131Sraj 63209131Sraj#include <dev/usb/usb.h> 64209131Sraj#include <dev/usb/usbdi.h> 65209131Sraj 66209131Sraj#include <dev/usb/usb_core.h> 67209131Sraj#include <dev/usb/usb_busdma.h> 68209131Sraj#include <dev/usb/usb_process.h> 69209131Sraj#include <dev/usb/usb_util.h> 70209131Sraj 71209131Sraj#include <dev/usb/usb_controller.h> 72209131Sraj#include <dev/usb/usb_bus.h> 73209131Sraj#include <dev/usb/controller/ehci.h> 74209131Sraj#include <dev/usb/controller/ehcireg.h> 75209131Sraj 76209131Sraj#include <arm/mv/mvreg.h> 77209131Sraj#include <arm/mv/mvvar.h> 78209131Sraj 79209131Sraj#define EHCI_VENDORID_MRVL 0x1286 80209131Sraj#define EHCI_HC_DEVSTR "Marvell Integrated USB 2.0 controller" 81209131Sraj 82209131Srajstatic device_attach_t mv_ehci_attach; 83209131Srajstatic device_detach_t mv_ehci_detach; 84209131Sraj 85209131Srajstatic int err_intr(void *arg); 86209131Sraj 87209131Srajstatic struct resource *irq_err; 88209131Srajstatic void *ih_err; 89209131Sraj 90209131Sraj/* EHCI HC regs start at this offset within USB range */ 91209131Sraj#define MV_USB_HOST_OFST 0x0100 92209131Sraj 93218461Smarcel#define USB_BRIDGE_INTR_CAUSE 0x210 94218461Smarcel#define USB_BRIDGE_INTR_MASK 0x214 95218461Smarcel#define USB_BRIDGE_ERR_ADDR 0x21C 96209131Sraj 97209131Sraj#define MV_USB_ADDR_DECODE_ERR (1 << 0) 98209131Sraj#define MV_USB_HOST_UNDERFLOW (1 << 1) 99209131Sraj#define MV_USB_HOST_OVERFLOW (1 << 2) 100209131Sraj#define MV_USB_DEVICE_UNDERFLOW (1 << 3) 101209131Sraj 102294427Szbbstatic struct ofw_compat_data compat_data[] = { 103294427Szbb {"mrvl,usb-ehci", true}, 104294427Szbb {"marvell,orion-ehci", true}, 105294427Szbb {NULL, false} 106294427Szbb}; 107294427Szbb 108294989Smmelstatic void 109294989Smmelmv_ehci_post_reset(struct ehci_softc *ehci_softc) 110294989Smmel{ 111294989Smmel uint32_t usbmode; 112294989Smmel 113294989Smmel /* Force HOST mode */ 114294989Smmel usbmode = EOREAD4(ehci_softc, EHCI_USBMODE_NOLPM); 115294989Smmel usbmode &= ~EHCI_UM_CM; 116294989Smmel usbmode |= EHCI_UM_CM_HOST; 117294989Smmel EOWRITE4(ehci_softc, EHCI_USBMODE_NOLPM, usbmode); 118294989Smmel} 119294989Smmel 120209131Srajstatic int 121209131Srajmv_ehci_probe(device_t self) 122209131Sraj{ 123209131Sraj 124261410Sian if (!ofw_bus_status_okay(self)) 125261410Sian return (ENXIO); 126261410Sian 127294427Szbb if (!ofw_bus_search_compatible(self, compat_data)->ocd_data) 128209131Sraj return (ENXIO); 129209131Sraj 130209131Sraj device_set_desc(self, EHCI_HC_DEVSTR); 131209131Sraj 132209131Sraj return (BUS_PROBE_DEFAULT); 133209131Sraj} 134209131Sraj 135209131Srajstatic int 136209131Srajmv_ehci_attach(device_t self) 137209131Sraj{ 138209131Sraj ehci_softc_t *sc = device_get_softc(self); 139209131Sraj bus_space_handle_t bsh; 140209131Sraj int err; 141209131Sraj int rid; 142209131Sraj 143209131Sraj /* initialise some bus fields */ 144209131Sraj sc->sc_bus.parent = self; 145209131Sraj sc->sc_bus.devices = sc->sc_devices; 146209131Sraj sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 147276717Shselasky sc->sc_bus.dma_bits = 32; 148209131Sraj 149209131Sraj /* get all DMA memory */ 150209131Sraj if (usb_bus_mem_alloc_all(&sc->sc_bus, 151209131Sraj USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 152209131Sraj return (ENOMEM); 153209131Sraj } 154209131Sraj 155209131Sraj rid = 0; 156209131Sraj sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 157209131Sraj if (!sc->sc_io_res) { 158209131Sraj device_printf(self, "Could not map memory\n"); 159209131Sraj goto error; 160209131Sraj } 161209131Sraj sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 162209131Sraj bsh = rman_get_bushandle(sc->sc_io_res); 163209131Sraj sc->sc_io_size = rman_get_size(sc->sc_io_res) - MV_USB_HOST_OFST; 164209131Sraj 165209131Sraj /* 166209131Sraj * Marvell EHCI host controller registers start at certain offset 167209131Sraj * within the whole USB registers range, so create a subregion for the 168209131Sraj * host mode configuration purposes. 169209131Sraj */ 170209131Sraj 171209131Sraj if (bus_space_subregion(sc->sc_io_tag, bsh, MV_USB_HOST_OFST, 172209131Sraj sc->sc_io_size, &sc->sc_io_hdl) != 0) 173209131Sraj panic("%s: unable to subregion USB host registers", 174209131Sraj device_get_name(self)); 175209131Sraj 176209131Sraj rid = 0; 177294427Szbb if (!ofw_bus_is_compatible(self, "marvell,orion-ehci")) { 178294427Szbb irq_err = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 179294427Szbb RF_SHAREABLE | RF_ACTIVE); 180294427Szbb if (irq_err == NULL) { 181294427Szbb device_printf(self, "Could not allocate error irq\n"); 182294427Szbb mv_ehci_detach(self); 183294427Szbb return (ENXIO); 184294427Szbb } 185294427Szbb rid = 1; 186209131Sraj } 187209131Sraj 188209131Sraj /* 189209131Sraj * Notice: Marvell EHCI controller has TWO interrupt lines, so make 190209131Sraj * sure to use the correct rid for the main one (controller interrupt) 191209131Sraj * -- refer to DTS for the right resource number to use here. 192209131Sraj */ 193209131Sraj sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 194209131Sraj RF_SHAREABLE | RF_ACTIVE); 195209131Sraj if (sc->sc_irq_res == NULL) { 196209131Sraj device_printf(self, "Could not allocate irq\n"); 197209131Sraj goto error; 198209131Sraj } 199209131Sraj 200209131Sraj sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 201209131Sraj if (!sc->sc_bus.bdev) { 202209131Sraj device_printf(self, "Could not add USB device\n"); 203209131Sraj goto error; 204209131Sraj } 205209131Sraj device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 206209131Sraj device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR); 207209131Sraj 208209131Sraj sprintf(sc->sc_vendor, "Marvell"); 209209131Sraj 210294427Szbb if (!ofw_bus_is_compatible(self, "marvell,orion-ehci")) { 211294427Szbb err = bus_setup_intr(self, irq_err, INTR_TYPE_BIO, 212294427Szbb err_intr, NULL, sc, &ih_err); 213294427Szbb if (err) { 214294427Szbb device_printf(self, "Could not setup error irq, %d\n", err); 215294427Szbb ih_err = NULL; 216294427Szbb goto error; 217294427Szbb } 218209131Sraj } 219209131Sraj 220209131Sraj EWRITE4(sc, USB_BRIDGE_INTR_MASK, MV_USB_ADDR_DECODE_ERR | 221209131Sraj MV_USB_HOST_UNDERFLOW | MV_USB_HOST_OVERFLOW | 222209131Sraj MV_USB_DEVICE_UNDERFLOW); 223209131Sraj 224209131Sraj err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 225209131Sraj NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 226209131Sraj if (err) { 227209131Sraj device_printf(self, "Could not setup irq, %d\n", err); 228209131Sraj sc->sc_intr_hdl = NULL; 229209131Sraj goto error; 230209131Sraj } 231209131Sraj 232209131Sraj /* 233209131Sraj * Workaround for Marvell integrated EHCI controller: reset of 234209131Sraj * the EHCI core clears the USBMODE register, which sets the core in 235209131Sraj * an undefined state (neither host nor agent), so it needs to be set 236209131Sraj * again for proper operation. 237209131Sraj * 238209131Sraj * Refer to errata document MV-S500832-00D.pdf (p. 5.24 GL USB-2) for 239209131Sraj * details. 240209131Sraj */ 241294989Smmel sc->sc_vendor_post_reset = mv_ehci_post_reset; 242209131Sraj if (bootverbose) 243209131Sraj device_printf(self, "5.24 GL USB-2 workaround enabled\n"); 244209131Sraj 245209131Sraj /* XXX all MV chips need it? */ 246294989Smmel sc->sc_flags |= EHCI_SCFLG_TT | EHCI_SCFLG_NORESTERM; 247294989Smmel sc->sc_vendor_get_port_speed = ehci_get_port_speed_portsc; 248209131Sraj err = ehci_init(sc); 249209131Sraj if (!err) { 250209131Sraj err = device_probe_and_attach(sc->sc_bus.bdev); 251209131Sraj } 252209131Sraj if (err) { 253209131Sraj device_printf(self, "USB init failed err=%d\n", err); 254209131Sraj goto error; 255209131Sraj } 256209131Sraj return (0); 257209131Sraj 258209131Srajerror: 259209131Sraj mv_ehci_detach(self); 260209131Sraj return (ENXIO); 261209131Sraj} 262209131Sraj 263209131Srajstatic int 264209131Srajmv_ehci_detach(device_t self) 265209131Sraj{ 266209131Sraj ehci_softc_t *sc = device_get_softc(self); 267209131Sraj device_t bdev; 268209131Sraj int err; 269209131Sraj 270209131Sraj if (sc->sc_bus.bdev) { 271209131Sraj bdev = sc->sc_bus.bdev; 272209131Sraj device_detach(bdev); 273209131Sraj device_delete_child(self, bdev); 274209131Sraj } 275209131Sraj /* during module unload there are lots of children leftover */ 276227849Shselasky device_delete_children(self); 277209131Sraj 278209131Sraj /* 279220558Shselasky * disable interrupts that might have been switched on in mv_ehci_attach 280209131Sraj */ 281209131Sraj if (sc->sc_io_res) { 282209131Sraj EWRITE4(sc, USB_BRIDGE_INTR_MASK, 0); 283209131Sraj } 284209131Sraj if (sc->sc_irq_res && sc->sc_intr_hdl) { 285209131Sraj /* 286209131Sraj * only call ehci_detach() after ehci_init() 287209131Sraj */ 288209131Sraj ehci_detach(sc); 289209131Sraj 290209131Sraj err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 291209131Sraj 292209131Sraj if (err) 293209131Sraj /* XXX or should we panic? */ 294209131Sraj device_printf(self, "Could not tear down irq, %d\n", 295209131Sraj err); 296209131Sraj sc->sc_intr_hdl = NULL; 297209131Sraj } 298209131Sraj if (irq_err && ih_err) { 299209131Sraj err = bus_teardown_intr(self, irq_err, ih_err); 300209131Sraj 301209131Sraj if (err) 302209131Sraj device_printf(self, "Could not tear down irq, %d\n", 303209131Sraj err); 304209131Sraj ih_err = NULL; 305209131Sraj } 306209131Sraj if (irq_err) { 307209131Sraj bus_release_resource(self, SYS_RES_IRQ, 0, irq_err); 308209131Sraj irq_err = NULL; 309209131Sraj } 310209131Sraj if (sc->sc_irq_res) { 311209131Sraj bus_release_resource(self, SYS_RES_IRQ, 1, sc->sc_irq_res); 312209131Sraj sc->sc_irq_res = NULL; 313209131Sraj } 314209131Sraj if (sc->sc_io_res) { 315209131Sraj bus_release_resource(self, SYS_RES_MEMORY, 0, 316209131Sraj sc->sc_io_res); 317209131Sraj sc->sc_io_res = NULL; 318209131Sraj } 319209131Sraj usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 320209131Sraj 321209131Sraj return (0); 322209131Sraj} 323209131Sraj 324209131Srajstatic int 325209131Srajerr_intr(void *arg) 326209131Sraj{ 327209131Sraj ehci_softc_t *sc = arg; 328209131Sraj unsigned int cause; 329209131Sraj 330209131Sraj cause = EREAD4(sc, USB_BRIDGE_INTR_CAUSE); 331209131Sraj if (cause) { 332218461Smarcel printf("USB error: "); 333218461Smarcel if (cause & MV_USB_ADDR_DECODE_ERR) { 334218461Smarcel uint32_t addr; 335218461Smarcel 336218461Smarcel addr = EREAD4(sc, USB_BRIDGE_ERR_ADDR); 337218461Smarcel printf("address decoding error (addr=%#x)\n", addr); 338218461Smarcel } 339209131Sraj if (cause & MV_USB_HOST_UNDERFLOW) 340218461Smarcel printf("host underflow\n"); 341209131Sraj if (cause & MV_USB_HOST_OVERFLOW) 342218461Smarcel printf("host overflow\n"); 343209131Sraj if (cause & MV_USB_DEVICE_UNDERFLOW) 344218461Smarcel printf("device underflow\n"); 345209131Sraj if (cause & ~(MV_USB_ADDR_DECODE_ERR | MV_USB_HOST_UNDERFLOW | 346209131Sraj MV_USB_HOST_OVERFLOW | MV_USB_DEVICE_UNDERFLOW)) 347218461Smarcel printf("unknown cause (cause=%#x)\n", cause); 348209131Sraj 349209131Sraj EWRITE4(sc, USB_BRIDGE_INTR_CAUSE, 0); 350209131Sraj } 351209131Sraj return (FILTER_HANDLED); 352209131Sraj} 353209131Sraj 354209131Srajstatic device_method_t ehci_methods[] = { 355209131Sraj /* Device interface */ 356209131Sraj DEVMETHOD(device_probe, mv_ehci_probe), 357209131Sraj DEVMETHOD(device_attach, mv_ehci_attach), 358209131Sraj DEVMETHOD(device_detach, mv_ehci_detach), 359228483Shselasky DEVMETHOD(device_suspend, bus_generic_suspend), 360228483Shselasky DEVMETHOD(device_resume, bus_generic_resume), 361228483Shselasky DEVMETHOD(device_shutdown, bus_generic_shutdown), 362209131Sraj 363227843Smarius DEVMETHOD_END 364209131Sraj}; 365209131Sraj 366209131Srajstatic driver_t ehci_driver = { 367209131Sraj "ehci", 368209131Sraj ehci_methods, 369209131Sraj sizeof(ehci_softc_t), 370209131Sraj}; 371209131Sraj 372209131Srajstatic devclass_t ehci_devclass; 373209131Sraj 374209131SrajDRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0); 375209131SrajMODULE_DEPEND(ehci, usb, 1, 1, 1); 376