am335x_usbss.c revision 276877
1/*- 2 * Copyright (c) 2013 Oleksandr Tymoshenko <gonzo@freebsd.org> 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23 * SUCH DAMAGE. 24 */ 25 26#include <sys/cdefs.h> 27__FBSDID("$FreeBSD: stable/10/sys/arm/ti/am335x/am335x_usbss.c 276877 2015-01-09 03:32:51Z loos $"); 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 48#include <dev/fdt/fdt_common.h> 49#include <dev/ofw/openfirm.h> 50#include <dev/ofw/ofw_bus.h> 51#include <dev/ofw/ofw_bus_subr.h> 52 53#include <dev/usb/usb.h> 54#include <dev/usb/usbdi.h> 55 56#include <dev/usb/usb_core.h> 57#include <dev/usb/usb_busdma.h> 58#include <dev/usb/usb_process.h> 59#include <dev/usb/usb_util.h> 60 61#define USB_DEBUG_VAR usbssdebug 62 63#include <dev/usb/usb_controller.h> 64#include <dev/usb/usb_bus.h> 65#include <dev/usb/controller/musb_otg.h> 66#include <dev/usb/usb_debug.h> 67 68#include <sys/rman.h> 69 70#include <arm/ti/ti_prcm.h> 71#include <arm/ti/ti_scm.h> 72#include <arm/ti/am335x/am335x_scm.h> 73 74#define AM335X_USB_PORTS 2 75 76#define USBSS_REVREG 0x00 77#define USBSS_SYSCONFIG 0x10 78#define USBSS_SYSCONFIG_SRESET 1 79 80#define USBCTRL_REV 0x00 81#define USBCTRL_CTRL 0x14 82#define USBCTRL_STAT 0x18 83#define USBCTRL_IRQ_STAT0 0x30 84#define IRQ_STAT0_RXSHIFT 16 85#define IRQ_STAT0_TXSHIFT 0 86#define USBCTRL_IRQ_STAT1 0x34 87#define IRQ_STAT1_DRVVBUS (1 << 8) 88#define USBCTRL_INTEN_SET0 0x38 89#define USBCTRL_INTEN_SET1 0x3C 90#define USBCTRL_INTEN_USB_ALL 0x1ff 91#define USBCTRL_INTEN_USB_SOF (1 << 3) 92#define USBCTRL_INTEN_CLR0 0x40 93#define USBCTRL_INTEN_CLR1 0x44 94#define USBCTRL_UTMI 0xE0 95#define USBCTRL_UTMI_FSDATAEXT (1 << 1) 96#define USBCTRL_MODE 0xE8 97#define USBCTRL_MODE_IDDIG (1 << 8) 98#define USBCTRL_MODE_IDDIGMUX (1 << 7) 99 100/* USBSS resource + 2 MUSB ports */ 101 102#define RES_USBSS 0 103#define RES_USBCTRL(i) (3*i+1) 104#define RES_USBPHY(i) (3*i+2) 105#define RES_USBCORE(i) (3*i+3) 106 107#define USB_WRITE4(sc, idx, reg, val) do { \ 108 bus_write_4((sc)->sc_mem_res[idx], (reg), (val)); \ 109} while (0) 110 111#define USB_READ4(sc, idx, reg) bus_read_4((sc)->sc_mem_res[idx], (reg)) 112 113#define USBSS_WRITE4(sc, reg, val) \ 114 USB_WRITE4((sc), RES_USBSS, (reg), (val)) 115#define USBSS_READ4(sc, reg) \ 116 USB_READ4((sc), RES_USBSS, (reg)) 117#define USBCTRL_WRITE4(sc, unit, reg, val) \ 118 USB_WRITE4((sc), RES_USBCTRL(unit), (reg), (val)) 119#define USBCTRL_READ4(sc, unit, reg) \ 120 USB_READ4((sc), RES_USBCTRL(unit), (reg)) 121#define USBPHY_WRITE4(sc, unit, reg, val) \ 122 USB_WRITE4((sc), RES_USBPHY(unit), (reg), (val)) 123#define USBPHY_READ4(sc, unit, reg) \ 124 USB_READ4((sc), RES_USBPHY(unit), (reg)) 125 126static struct resource_spec am335x_musbotg_mem_spec[] = { 127 { SYS_RES_MEMORY, 0, RF_ACTIVE }, 128 { SYS_RES_MEMORY, 1, RF_ACTIVE }, 129 { SYS_RES_MEMORY, 2, RF_ACTIVE }, 130 { SYS_RES_MEMORY, 3, RF_ACTIVE }, 131 { SYS_RES_MEMORY, 4, RF_ACTIVE }, 132 { SYS_RES_MEMORY, 5, RF_ACTIVE }, 133 { SYS_RES_MEMORY, 6, RF_ACTIVE }, 134 { -1, 0, 0 } 135}; 136 137static struct resource_spec am335x_musbotg_irq_spec[] = { 138 { SYS_RES_IRQ, 0, RF_ACTIVE }, 139 { SYS_RES_IRQ, 1, RF_ACTIVE }, 140 { SYS_RES_IRQ, 2, RF_ACTIVE }, 141 { -1, 0, 0 } 142}; 143 144#ifdef USB_DEBUG 145static int usbssdebug = 0; 146 147static SYSCTL_NODE(_hw_usb, OID_AUTO, am335x_usbss, CTLFLAG_RW, 0, "AM335x USBSS"); 148SYSCTL_INT(_hw_usb_am335x_usbss, OID_AUTO, debug, CTLFLAG_RW, 149 &usbssdebug, 0, "Debug level"); 150#endif 151 152static device_probe_t musbotg_probe; 153static device_attach_t musbotg_attach; 154static device_detach_t musbotg_detach; 155 156struct musbotg_super_softc { 157 struct musbotg_softc sc_otg[AM335X_USB_PORTS]; 158 struct resource *sc_mem_res[AM335X_USB_PORTS*3+1]; 159 struct resource *sc_irq_res[AM335X_USB_PORTS+1]; 160 void *sc_intr_hdl; 161}; 162 163static void 164musbotg_vbus_poll(struct musbotg_super_softc *sc, int port) 165{ 166 uint32_t stat; 167 168 if (sc->sc_otg[port].sc_mode == MUSB2_DEVICE_MODE) 169 musbotg_vbus_interrupt(&sc->sc_otg[port], 1); 170 else { 171 stat = USBCTRL_READ4(sc, port, USBCTRL_STAT); 172 musbotg_vbus_interrupt(&sc->sc_otg[port], stat & 1); 173 } 174} 175 176/* 177 * Arg to musbotg_clocks_on and musbot_clocks_off is 178 * a uint32_t * pointing to the SCM register offset. 179 */ 180static uint32_t USB_CTRL[] = {SCM_USB_CTRL0, SCM_USB_CTRL1}; 181 182static void 183musbotg_clocks_on(void *arg) 184{ 185 uint32_t c, reg = *(uint32_t *)arg; 186 187 ti_scm_reg_read_4(reg, &c); 188 c &= ~3; /* Enable power */ 189 c |= 1 << 19; /* VBUS detect enable */ 190 c |= 1 << 20; /* Session end enable */ 191 ti_scm_reg_write_4(reg, c); 192} 193 194static void 195musbotg_clocks_off(void *arg) 196{ 197 uint32_t c, reg = *(uint32_t *)arg; 198 199 /* Disable power to PHY */ 200 ti_scm_reg_read_4(reg, &c); 201 ti_scm_reg_write_4(reg, c | 3); 202} 203 204static void 205musbotg_ep_int_set(struct musbotg_softc *sc, int ep, int on) 206{ 207 struct musbotg_super_softc *ssc = sc->sc_platform_data; 208 uint32_t epmask; 209 210 epmask = ((1 << ep) << IRQ_STAT0_RXSHIFT); 211 epmask |= ((1 << ep) << IRQ_STAT0_TXSHIFT); 212 if (on) 213 USBCTRL_WRITE4(ssc, sc->sc_id, 214 USBCTRL_INTEN_SET0, epmask); 215 else 216 USBCTRL_WRITE4(ssc, sc->sc_id, 217 USBCTRL_INTEN_CLR0, epmask); 218} 219 220static void 221musbotg_usbss_interrupt(void *arg) 222{ 223 panic("USBSS real interrupt"); 224} 225 226static void 227musbotg_wrapper_interrupt(void *arg) 228{ 229 struct musbotg_softc *sc = arg; 230 struct musbotg_super_softc *ssc = sc->sc_platform_data; 231 uint32_t stat, stat0, stat1; 232 stat = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_STAT); 233 stat0 = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_IRQ_STAT0); 234 stat1 = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_IRQ_STAT1); 235 if (stat0) 236 USBCTRL_WRITE4(ssc, sc->sc_id, USBCTRL_IRQ_STAT0, stat0); 237 if (stat1) 238 USBCTRL_WRITE4(ssc, sc->sc_id, USBCTRL_IRQ_STAT1, stat1); 239 240 DPRINTFN(4, "port%d: stat0=%08x stat1=%08x, stat=%08x\n", 241 sc->sc_id, stat0, stat1, stat); 242 243 if (stat1 & IRQ_STAT1_DRVVBUS) 244 musbotg_vbus_interrupt(sc, stat & 1); 245 246 musbotg_interrupt(arg, ((stat0 >> 16) & 0xffff), 247 stat0 & 0xffff, stat1 & 0xff); 248} 249 250static int 251musbotg_probe(device_t dev) 252{ 253 254 if (!ofw_bus_status_okay(dev)) 255 return (ENXIO); 256 257 if (!ofw_bus_is_compatible(dev, "ti,musb-am33xx")) 258 return (ENXIO); 259 260 device_set_desc(dev, "TI AM33xx integrated USB OTG controller"); 261 262 return (BUS_PROBE_DEFAULT); 263} 264 265static int 266musbotg_attach(device_t dev) 267{ 268 struct musbotg_super_softc *sc = device_get_softc(dev); 269 int err; 270 int i; 271 uint32_t rev, reg; 272 273 /* Request the memory resources */ 274 err = bus_alloc_resources(dev, am335x_musbotg_mem_spec, 275 sc->sc_mem_res); 276 if (err) { 277 device_printf(dev, 278 "Error: could not allocate mem resources\n"); 279 return (ENXIO); 280 } 281 282 /* Request the IRQ resources */ 283 err = bus_alloc_resources(dev, am335x_musbotg_irq_spec, 284 sc->sc_irq_res); 285 if (err) { 286 device_printf(dev, 287 "Error: could not allocate irq resources\n"); 288 return (ENXIO); 289 } 290 291 /* Enable device clocks. */ 292 ti_prcm_clk_enable(MUSB0_CLK); 293 294 /* 295 * Reset USBSS, USB0 and USB1. 296 * The registers of USB subsystem must not be accessed while the 297 * reset pulse is active (200ns). 298 */ 299 USBSS_WRITE4(sc, USBSS_SYSCONFIG, USBSS_SYSCONFIG_SRESET); 300 DELAY(100); 301 i = 10; 302 while (USBSS_READ4(sc, USBSS_SYSCONFIG) & USBSS_SYSCONFIG_SRESET) { 303 DELAY(100); 304 if (i-- == 0) { 305 device_printf(dev, "reset timeout.\n"); 306 return (ENXIO); 307 } 308 } 309 310 /* Read the module revision. */ 311 rev = USBSS_READ4(sc, USBSS_REVREG); 312 device_printf(dev, "TI AM335X USBSS v%d.%d.%d\n", 313 (rev >> 8) & 7, (rev >> 6) & 3, rev & 63); 314 315 err = bus_setup_intr(dev, sc->sc_irq_res[0], 316 INTR_TYPE_BIO | INTR_MPSAFE, 317 NULL, (driver_intr_t *)musbotg_usbss_interrupt, sc, 318 &sc->sc_intr_hdl); 319 320 if (err) { 321 sc->sc_intr_hdl = NULL; 322 device_printf(dev, "Failed to setup USBSS interrupt\n"); 323 goto error; 324 } 325 326 for (i = 0; i < AM335X_USB_PORTS; i++) { 327 /* setup MUSB OTG USB controller interface softc */ 328 sc->sc_otg[i].sc_clocks_on = &musbotg_clocks_on; 329 sc->sc_otg[i].sc_clocks_off = &musbotg_clocks_off; 330 sc->sc_otg[i].sc_clocks_arg = &USB_CTRL[i]; 331 332 sc->sc_otg[i].sc_ep_int_set = musbotg_ep_int_set; 333 334 /* initialise some bus fields */ 335 sc->sc_otg[i].sc_bus.parent = dev; 336 sc->sc_otg[i].sc_bus.devices = sc->sc_otg[i].sc_devices; 337 sc->sc_otg[i].sc_bus.devices_max = MUSB2_MAX_DEVICES; 338 339 /* get all DMA memory */ 340 if (usb_bus_mem_alloc_all(&sc->sc_otg[i].sc_bus, 341 USB_GET_DMA_TAG(dev), NULL)) { 342 device_printf(dev, 343 "Failed allocate bus mem for musb%d\n", i); 344 return (ENOMEM); 345 } 346 sc->sc_otg[i].sc_io_res = sc->sc_mem_res[RES_USBCORE(i)]; 347 sc->sc_otg[i].sc_io_tag = 348 rman_get_bustag(sc->sc_otg[i].sc_io_res); 349 sc->sc_otg[i].sc_io_hdl = 350 rman_get_bushandle(sc->sc_otg[i].sc_io_res); 351 sc->sc_otg[i].sc_io_size = 352 rman_get_size(sc->sc_otg[i].sc_io_res); 353 354 sc->sc_otg[i].sc_irq_res = sc->sc_irq_res[i+1]; 355 356 sc->sc_otg[i].sc_bus.bdev = device_add_child(dev, "usbus", -1); 357 if (!(sc->sc_otg[i].sc_bus.bdev)) { 358 device_printf(dev, "No busdev for musb%d\n", i); 359 goto error; 360 } 361 device_set_ivars(sc->sc_otg[i].sc_bus.bdev, 362 &sc->sc_otg[i].sc_bus); 363 364 err = bus_setup_intr(dev, sc->sc_otg[i].sc_irq_res, 365 INTR_TYPE_BIO | INTR_MPSAFE, 366 NULL, (driver_intr_t *)musbotg_wrapper_interrupt, 367 &sc->sc_otg[i], &sc->sc_otg[i].sc_intr_hdl); 368 if (err) { 369 sc->sc_otg[i].sc_intr_hdl = NULL; 370 device_printf(dev, 371 "Failed to setup interrupt for musb%d\n", i); 372 goto error; 373 } 374 375 sc->sc_otg[i].sc_id = i; 376 sc->sc_otg[i].sc_platform_data = sc; 377 if (i == 0) 378 sc->sc_otg[i].sc_mode = MUSB2_DEVICE_MODE; 379 else 380 sc->sc_otg[i].sc_mode = MUSB2_HOST_MODE; 381 382 /* 383 * software-controlled function 384 */ 385 386 if (sc->sc_otg[i].sc_mode == MUSB2_HOST_MODE) { 387 reg = USBCTRL_READ4(sc, i, USBCTRL_MODE); 388 reg |= USBCTRL_MODE_IDDIGMUX; 389 reg &= ~USBCTRL_MODE_IDDIG; 390 USBCTRL_WRITE4(sc, i, USBCTRL_MODE, reg); 391 USBCTRL_WRITE4(sc, i, USBCTRL_UTMI, 392 USBCTRL_UTMI_FSDATAEXT); 393 } else { 394 reg = USBCTRL_READ4(sc, i, USBCTRL_MODE); 395 reg |= USBCTRL_MODE_IDDIGMUX; 396 reg |= USBCTRL_MODE_IDDIG; 397 USBCTRL_WRITE4(sc, i, USBCTRL_MODE, reg); 398 } 399 400 reg = USBCTRL_INTEN_USB_ALL & ~USBCTRL_INTEN_USB_SOF; 401 USBCTRL_WRITE4(sc, i, USBCTRL_INTEN_SET1, reg); 402 USBCTRL_WRITE4(sc, i, USBCTRL_INTEN_CLR0, 0xffffffff); 403 404 err = musbotg_init(&sc->sc_otg[i]); 405 if (!err) 406 err = device_probe_and_attach(sc->sc_otg[i].sc_bus.bdev); 407 408 if (err) 409 goto error; 410 411 /* poll VBUS one time */ 412 musbotg_vbus_poll(sc, i); 413 } 414 415 return (0); 416 417error: 418 musbotg_detach(dev); 419 return (ENXIO); 420} 421 422static int 423musbotg_detach(device_t dev) 424{ 425 struct musbotg_super_softc *sc = device_get_softc(dev); 426 device_t bdev; 427 int err; 428 int i; 429 430 for (i = 0; i < AM335X_USB_PORTS; i++) { 431 if (sc->sc_otg[i].sc_bus.bdev) { 432 bdev = sc->sc_otg[i].sc_bus.bdev; 433 device_detach(bdev); 434 device_delete_child(dev, bdev); 435 } 436 437 if (sc->sc_otg[i].sc_irq_res && sc->sc_otg[i].sc_intr_hdl) { 438 /* 439 * only call musbotg_uninit() after musbotg_init() 440 */ 441 musbotg_uninit(&sc->sc_otg[i]); 442 443 err = bus_teardown_intr(dev, sc->sc_otg[i].sc_irq_res, 444 sc->sc_otg[i].sc_intr_hdl); 445 sc->sc_otg[i].sc_intr_hdl = NULL; 446 } 447 448 usb_bus_mem_free_all(&sc->sc_otg[i].sc_bus, NULL); 449 } 450 451 if (sc->sc_intr_hdl) { 452 bus_teardown_intr(dev, sc->sc_irq_res[0], 453 sc->sc_intr_hdl); 454 sc->sc_intr_hdl = NULL; 455 } 456 457 458 /* Free resources if any */ 459 if (sc->sc_mem_res[0]) 460 bus_release_resources(dev, am335x_musbotg_mem_spec, 461 sc->sc_mem_res); 462 463 if (sc->sc_irq_res[0]) 464 bus_release_resources(dev, am335x_musbotg_irq_spec, 465 sc->sc_irq_res); 466 467 /* during module unload there are lots of children leftover */ 468 device_delete_children(dev); 469 470 return (0); 471} 472 473static device_method_t musbotg_methods[] = { 474 /* Device interface */ 475 DEVMETHOD(device_probe, musbotg_probe), 476 DEVMETHOD(device_attach, musbotg_attach), 477 DEVMETHOD(device_detach, musbotg_detach), 478 DEVMETHOD(device_suspend, bus_generic_suspend), 479 DEVMETHOD(device_resume, bus_generic_resume), 480 DEVMETHOD(device_shutdown, bus_generic_shutdown), 481 482 DEVMETHOD_END 483}; 484 485static driver_t musbotg_driver = { 486 .name = "musbotg", 487 .methods = musbotg_methods, 488 .size = sizeof(struct musbotg_super_softc), 489}; 490 491static devclass_t musbotg_devclass; 492 493DRIVER_MODULE(musbotg, simplebus, musbotg_driver, musbotg_devclass, 0, 0); 494MODULE_DEPEND(musbotg, usb, 1, 1, 1); 495