1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2010-2012 Semihalf 5 * Copyright (c) 2012 The FreeBSD Foundation 6 * Copyright (c) 2013 Ian Lepore <ian@freebsd.org> 7 * All rights reserved. 8 * 9 * Portions of this software were developed by Oleksandr Rybalko 10 * under sponsorship from the FreeBSD Foundation. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34#include <sys/cdefs.h> 35/* 36 * EHCI driver for Freescale i.MX SoCs which incorporate the USBOH3 controller. 37 */ 38 39#include <sys/param.h> 40#include <sys/systm.h> 41#include <sys/kernel.h> 42#include <sys/module.h> 43#include <sys/bus.h> 44#include <sys/condvar.h> 45#include <sys/rman.h> 46 47#include <dev/ofw/ofw_bus.h> 48#include <dev/ofw/ofw_bus_subr.h> 49 50#include <dev/usb/usb.h> 51#include <dev/usb/usbdi.h> 52#include <dev/usb/usb_busdma.h> 53#include <dev/usb/usb_process.h> 54#include <dev/usb/usb_controller.h> 55#include <dev/usb/usb_bus.h> 56#include <dev/usb/controller/ehci.h> 57#include <dev/usb/controller/ehcireg.h> 58#include "usbdevs.h" 59 60#include <machine/bus.h> 61#include <machine/resource.h> 62 63#include <arm/freescale/imx/imx_ccmvar.h> 64 65#include "opt_platform.h" 66 67/* 68 * Notes on the hardware and related FDT data seen in the wild. 69 * 70 * There are two sets of registers in the USBOH3 implementation; documentation 71 * refers to them as "core" and "non-core" registers. A set of core register 72 * exists for each OTG or EHCI device. There is a single set of non-core 73 * registers per USBOH3, and they control aspects of operation not directly 74 * related to the USB specs, such as whether interrupts from each of the core 75 * devices are able to generate a SoC wakeup event. 76 * 77 * In the FreeBSD universe we might be inclined to describe the core and 78 * non-core registers by using a pair of resource address/size values (two 79 * entries in the reg property for each core). However, we have to work with 80 * existing FDT data (which mostly comes from the linux universe), and the way 81 * they've chosen to represent this is with an entry for a "usbmisc" device 82 * whose reg property describes the non-core registers. The way we handle FDT 83 * data, this means that the resources (memory-mapped register range) for the 84 * non-core registers belongs to a device other than the echi devices. 85 * 86 * Because the main ehci device cannot access registers in a range that's 87 * defined in the fdt data as belonging to another device, we implement a teeny 88 * little "usbmisc" driver which exists only to provide access to the usbmisc 89 * control register for each of the 4 usb controller instances. That little 90 * driver is implemented here in this file, before the main driver. 91 * 92 * In addition to the single usbmisc device, the existing FDT data defines a 93 * separate device for each of the OTG or EHCI cores within the USBOH3. Each of 94 * those devices has a set of core registers described by the reg property. 95 * 96 * The core registers for each of the four cores in the USBOH3 are divided into 97 * two parts: a set of imx-specific registers at an offset of 0 from the 98 * beginning of the register range, and the standard USB (EHCI or OTG) registers 99 * at an offset of 0x100 from the beginning of the register range. The FreeBSD 100 * way of dealing with this might be to map out two ranges in the reg property, 101 * but that's not what the alternate universe has done. To work with existing 102 * FDT data, we acquire the resource that maps all the core registers, then use 103 * bus_space_subregion() to create another resource that maps just the standard 104 * USB registers, which we provide to the standard USB code in the ehci_softc. 105 * 106 * The following compat strings have been seen for the OTG and EHCI cores. The 107 * FDT compat table in this driver contains all these strings, but as of this 108 * writing, not all of these SoCs have been tested with the driver. The fact 109 * that imx27 is common to all of them gives some hope that the driver will work 110 * on all these SoCs. 111 * - "fsl,imx23-usb", "fsl,imx27-usb"; 112 * - "fsl,imx25-usb", "fsl,imx27-usb"; 113 * - "fsl,imx28-usb", "fsl,imx27-usb"; 114 * - "fsl,imx51-usb", "fsl,imx27-usb"; 115 * - "fsl,imx53-usb", "fsl,imx27-usb"; 116 * - "fsl,imx6q-usb", "fsl,imx27-usb"; 117 * 118 * The FDT data for some SoCs contains the following properties, which we don't 119 * currently do anything with: 120 * - fsl,usbmisc = <&usbmisc 0>; 121 * - fsl,usbphy = <&usbphy0>; 122 * 123 * Some imx SoCs have FDT data related to USB PHY, some don't. We have separate 124 * usbphy drivers where needed; this data is mentioned here just to keep all the 125 * imx-FDT-usb-related info in one place. Here are the usbphy compat strings 126 * known to exist: 127 * - "nop-usbphy" 128 * - "usb-nop-xceiv"; 129 * - "fsl,imx23-usbphy" 130 * - "fsl,imx28-usbphy", "fsl,imx23-usbphy"; 131 * - "fsl,imx6q-usbphy", "fsl,imx23-usbphy"; 132 * 133 */ 134 135/*----------------------------------------------------------------------------- 136 * imx_usbmisc driver 137 *---------------------------------------------------------------------------*/ 138 139#define USBNC_OVER_CUR_POL (1u << 8) 140#define USBNC_OVER_CUR_DIS (1u << 7) 141 142struct imx_usbmisc_softc { 143 device_t dev; 144 struct resource *mmio; 145}; 146 147static struct ofw_compat_data usbmisc_compat_data[] = { 148 {"fsl,imx6q-usbmisc", true}, 149 {"fsl,imx51-usbmisc", true}, 150 {"fsl,imx25-usbmisc", true}, 151 {NULL, false}, 152}; 153 154static void 155imx_usbmisc_set_ctrl(device_t dev, u_int index, uint32_t bits) 156{ 157 struct imx_usbmisc_softc *sc; 158 uint32_t reg; 159 160 sc = device_get_softc(dev); 161 reg = bus_read_4(sc->mmio, index * sizeof(uint32_t)); 162 bus_write_4(sc->mmio, index * sizeof(uint32_t), reg | bits); 163} 164 165#ifdef notyet 166static void 167imx_usbmisc_clr_ctrl(device_t dev, u_int index, uint32_t bits) 168{ 169 struct imx_usbmisc_softc *sc; 170 uint32_t reg; 171 172 sc = device_get_softc(dev); 173 reg = bus_read_4(sc->mmio, index * sizeof(uint32_t)); 174 bus_write_4(sc->mmio, index * sizeof(uint32_t), reg & ~bits); 175} 176#endif 177 178static int 179imx_usbmisc_probe(device_t dev) 180{ 181 182 if (!ofw_bus_status_okay(dev)) 183 return (ENXIO); 184 185 if (ofw_bus_search_compatible(dev, usbmisc_compat_data)->ocd_data) { 186 device_set_desc(dev, "i.MX USB Misc Control"); 187 return (BUS_PROBE_DEFAULT); 188 } 189 return (ENXIO); 190} 191 192static int 193imx_usbmisc_detach(device_t dev) 194{ 195 struct imx_usbmisc_softc *sc; 196 197 sc = device_get_softc(dev); 198 199 if (sc->mmio != NULL) 200 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->mmio); 201 202 return (0); 203} 204 205static int 206imx_usbmisc_attach(device_t dev) 207{ 208 struct imx_usbmisc_softc *sc; 209 int rid; 210 211 sc = device_get_softc(dev); 212 213 /* Allocate bus_space resources. */ 214 rid = 0; 215 sc->mmio = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 216 RF_ACTIVE); 217 if (sc->mmio == NULL) { 218 device_printf(dev, "Cannot allocate memory resources\n"); 219 return (ENXIO); 220 } 221 222 OF_device_register_xref(OF_xref_from_node(ofw_bus_get_node(dev)), dev); 223 224 return (0); 225} 226 227static device_method_t imx_usbmisc_methods[] = { 228 /* Device interface */ 229 DEVMETHOD(device_probe, imx_usbmisc_probe), 230 DEVMETHOD(device_attach, imx_usbmisc_attach), 231 DEVMETHOD(device_detach, imx_usbmisc_detach), 232 233 DEVMETHOD_END 234}; 235 236static driver_t imx_usbmisc_driver = { 237 "imx_usbmisc", 238 imx_usbmisc_methods, 239 sizeof(struct imx_usbmisc_softc) 240}; 241 242/* 243 * This driver needs to start before the ehci driver, but later than the usual 244 * "special" drivers like clocks and cpu. Ehci starts at DEFAULT so 245 * DEFAULT-1000 seems good. 246 */ 247EARLY_DRIVER_MODULE(imx_usbmisc, simplebus, imx_usbmisc_driver, 248 0, 0, BUS_PASS_DEFAULT - 1000); 249 250/*----------------------------------------------------------------------------- 251 * imx_ehci driver... 252 *---------------------------------------------------------------------------*/ 253 254/* 255 * Each EHCI device in the SoC has some SoC-specific per-device registers at an 256 * offset of 0, then the standard EHCI registers begin at an offset of 0x100. 257 */ 258#define IMX_EHCI_REG_OFF 0x100 259#define IMX_EHCI_REG_SIZE 0x100 260 261struct imx_ehci_softc { 262 ehci_softc_t ehci_softc; 263 device_t dev; 264 struct resource *ehci_mem_res; /* EHCI core regs. */ 265 struct resource *ehci_irq_res; /* EHCI core IRQ. */ 266}; 267 268static struct ofw_compat_data compat_data[] = { 269 {"fsl,imx6q-usb", 1}, 270 {"fsl,imx53-usb", 1}, 271 {"fsl,imx51-usb", 1}, 272 {"fsl,imx28-usb", 1}, 273 {"fsl,imx27-usb", 1}, 274 {"fsl,imx25-usb", 1}, 275 {"fsl,imx23-usb", 1}, 276 {NULL, 0}, 277}; 278 279static void 280imx_ehci_post_reset(struct ehci_softc *ehci_softc) 281{ 282 uint32_t usbmode; 283 284 /* Force HOST mode */ 285 usbmode = EOREAD4(ehci_softc, EHCI_USBMODE_NOLPM); 286 usbmode &= ~EHCI_UM_CM; 287 usbmode |= EHCI_UM_CM_HOST; 288 EOWRITE4(ehci_softc, EHCI_USBMODE_NOLPM, usbmode); 289} 290 291static int 292imx_ehci_probe(device_t dev) 293{ 294 295 if (!ofw_bus_status_okay(dev)) 296 return (ENXIO); 297 298 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data != 0) { 299 device_set_desc(dev, "Freescale i.MX integrated USB controller"); 300 return (BUS_PROBE_DEFAULT); 301 } 302 return (ENXIO); 303} 304 305static int 306imx_ehci_detach(device_t dev) 307{ 308 struct imx_ehci_softc *sc; 309 ehci_softc_t *esc; 310 int err; 311 312 sc = device_get_softc(dev); 313 314 esc = &sc->ehci_softc; 315 316 /* First detach all children; we can't detach if that fails. */ 317 if ((err = device_delete_children(dev)) != 0) 318 return (err); 319 320 if (esc->sc_flags & EHCI_SCFLG_DONEINIT) 321 ehci_detach(esc); 322 if (esc->sc_intr_hdl != NULL) 323 bus_teardown_intr(dev, esc->sc_irq_res, 324 esc->sc_intr_hdl); 325 if (sc->ehci_irq_res != NULL) 326 bus_release_resource(dev, SYS_RES_IRQ, 0, 327 sc->ehci_irq_res); 328 if (sc->ehci_mem_res != NULL) 329 bus_release_resource(dev, SYS_RES_MEMORY, 0, 330 sc->ehci_mem_res); 331 332 usb_bus_mem_free_all(&esc->sc_bus, &ehci_iterate_hw_softc); 333 334 return (0); 335} 336 337static void 338imx_ehci_disable_oc(struct imx_ehci_softc *sc) 339{ 340 device_t usbmdev; 341 pcell_t usbmprops[2]; 342 phandle_t node; 343 ssize_t size; 344 int index; 345 346 /* Get the reference to the usbmisc driver from the fdt data */ 347 node = ofw_bus_get_node(sc->dev); 348 size = OF_getencprop(node, "fsl,usbmisc", usbmprops, 349 sizeof(usbmprops)); 350 if (size < sizeof(usbmprops)) { 351 device_printf(sc->dev, "failed to retrieve fsl,usbmisc " 352 "property, cannot disable overcurrent protection"); 353 return; 354 } 355 /* Retrieve the device_t via the xref handle. */ 356 usbmdev = OF_device_from_xref(usbmprops[0]); 357 if (usbmdev == NULL) { 358 device_printf(sc->dev, "usbmisc device not found, " 359 "cannot disable overcurrent protection"); 360 return; 361 } 362 /* Call the device routine to set the overcurrent disable bit. */ 363 index = usbmprops[1]; 364 imx_usbmisc_set_ctrl(usbmdev, index, USBNC_OVER_CUR_DIS); 365} 366 367static int 368imx_ehci_attach(device_t dev) 369{ 370 struct imx_ehci_softc *sc; 371 ehci_softc_t *esc; 372 int err, rid; 373 374 sc = device_get_softc(dev); 375 sc->dev = dev; 376 esc = &sc->ehci_softc; 377 err = 0; 378 379 /* Allocate bus_space resources. */ 380 rid = 0; 381 sc->ehci_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 382 RF_ACTIVE); 383 if (sc->ehci_mem_res == NULL) { 384 device_printf(dev, "Cannot allocate memory resources\n"); 385 err = ENXIO; 386 goto out; 387 } 388 389 rid = 0; 390 sc->ehci_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 391 RF_ACTIVE); 392 if (sc->ehci_irq_res == NULL) { 393 device_printf(dev, "Cannot allocate IRQ resources\n"); 394 err = ENXIO; 395 goto out; 396 } 397 398 esc->sc_io_tag = rman_get_bustag(sc->ehci_mem_res); 399 esc->sc_bus.parent = dev; 400 esc->sc_bus.devices = esc->sc_devices; 401 esc->sc_bus.devices_max = EHCI_MAX_DEVICES; 402 esc->sc_bus.dma_bits = 32; 403 404 /* allocate all DMA memory */ 405 if (usb_bus_mem_alloc_all(&esc->sc_bus, USB_GET_DMA_TAG(dev), 406 &ehci_iterate_hw_softc) != 0) { 407 device_printf(dev, "usb_bus_mem_alloc_all() failed\n"); 408 err = ENOMEM; 409 goto out; 410 } 411 412 /* 413 * Set handle to USB related registers subregion used by 414 * generic EHCI driver. 415 */ 416 err = bus_space_subregion(esc->sc_io_tag, 417 rman_get_bushandle(sc->ehci_mem_res), 418 IMX_EHCI_REG_OFF, IMX_EHCI_REG_SIZE, &esc->sc_io_hdl); 419 if (err != 0) { 420 device_printf(dev, "bus_space_subregion() failed\n"); 421 err = ENXIO; 422 goto out; 423 } 424 425 /* Setup interrupt handler. */ 426 err = bus_setup_intr(dev, sc->ehci_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 427 NULL, (driver_intr_t *)ehci_interrupt, esc, &esc->sc_intr_hdl); 428 if (err != 0) { 429 device_printf(dev, "Could not setup IRQ\n"); 430 goto out; 431 } 432 433 /* Turn on clocks. */ 434 imx_ccm_usb_enable(dev); 435 436 /* Disable overcurrent detection, if configured to do so. */ 437 if (OF_hasprop(ofw_bus_get_node(sc->dev), "disable-over-current")) 438 imx_ehci_disable_oc(sc); 439 440 /* Add USB bus device. */ 441 esc->sc_bus.bdev = device_add_child(dev, "usbus", -1); 442 if (esc->sc_bus.bdev == NULL) { 443 device_printf(dev, "Could not add USB device\n"); 444 goto out; 445 } 446 device_set_ivars(esc->sc_bus.bdev, &esc->sc_bus); 447 448 esc->sc_id_vendor = USB_VENDOR_FREESCALE; 449 strlcpy(esc->sc_vendor, "Freescale", sizeof(esc->sc_vendor)); 450 451 /* 452 * Set flags that affect ehci_init() behavior, and hook our post-reset 453 * code into the standard controller code. 454 */ 455 esc->sc_flags |= EHCI_SCFLG_NORESTERM | EHCI_SCFLG_TT; 456 esc->sc_vendor_post_reset = imx_ehci_post_reset; 457 esc->sc_vendor_get_port_speed = ehci_get_port_speed_portsc; 458 459 err = ehci_init(esc); 460 if (err != 0) { 461 device_printf(dev, "USB init failed, usb_err_t=%d\n", 462 err); 463 goto out; 464 } 465 esc->sc_flags |= EHCI_SCFLG_DONEINIT; 466 467 /* Probe the bus. */ 468 err = device_probe_and_attach(esc->sc_bus.bdev); 469 if (err != 0) { 470 device_printf(dev, 471 "device_probe_and_attach() failed\n"); 472 goto out; 473 } 474 475 err = 0; 476 477out: 478 479 if (err != 0) 480 imx_ehci_detach(dev); 481 482 return (err); 483} 484 485static device_method_t ehci_methods[] = { 486 /* Device interface */ 487 DEVMETHOD(device_probe, imx_ehci_probe), 488 DEVMETHOD(device_attach, imx_ehci_attach), 489 DEVMETHOD(device_detach, imx_ehci_detach), 490 DEVMETHOD(device_suspend, bus_generic_suspend), 491 DEVMETHOD(device_resume, bus_generic_resume), 492 DEVMETHOD(device_shutdown, bus_generic_shutdown), 493 494 /* Bus interface */ 495 DEVMETHOD(bus_print_child, bus_generic_print_child), 496 497 DEVMETHOD_END 498}; 499 500static driver_t ehci_driver = { 501 "ehci", 502 ehci_methods, 503 sizeof(struct imx_ehci_softc) 504}; 505 506DRIVER_MODULE(imx_ehci, simplebus, ehci_driver, 0, 0); 507MODULE_DEPEND(imx_ehci, usb, 1, 1, 1); 508