musb_dsps.c revision 8b9fcce2d88586b9a120ff3e039d8f42413f0bb0
1/* 2 * Texas Instruments DSPS platforms "glue layer" 3 * 4 * Copyright (C) 2012, by Texas Instruments 5 * 6 * Based on the am35x "glue layer" code. 7 * 8 * This file is part of the Inventra Controller Driver for Linux. 9 * 10 * The Inventra Controller Driver for Linux is free software; you 11 * can redistribute it and/or modify it under the terms of the GNU 12 * General Public License version 2 as published by the Free Software 13 * Foundation. 14 * 15 * The Inventra Controller Driver for Linux is distributed in 16 * the hope that it will be useful, but WITHOUT ANY WARRANTY; 17 * without even the implied warranty of MERCHANTABILITY or 18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public 19 * License for more details. 20 * 21 * You should have received a copy of the GNU General Public License 22 * along with The Inventra Controller Driver for Linux ; if not, 23 * write to the Free Software Foundation, Inc., 59 Temple Place, 24 * Suite 330, Boston, MA 02111-1307 USA 25 * 26 * musb_dsps.c will be a common file for all the TI DSPS platforms 27 * such as dm64x, dm36x, dm35x, da8x, am35x and ti81x. 28 * For now only ti81x is using this and in future davinci.c, am35x.c 29 * da8xx.c would be merged to this file after testing. 30 */ 31 32#include <linux/init.h> 33#include <linux/io.h> 34#include <linux/err.h> 35#include <linux/platform_device.h> 36#include <linux/dma-mapping.h> 37#include <linux/pm_runtime.h> 38#include <linux/module.h> 39#include <linux/usb/usb_phy_gen_xceiv.h> 40#include <linux/platform_data/usb-omap.h> 41#include <linux/sizes.h> 42 43#include <linux/of.h> 44#include <linux/of_device.h> 45#include <linux/of_address.h> 46#include <linux/of_irq.h> 47#include <linux/usb/of.h> 48 49#include "musb_core.h" 50 51static const struct of_device_id musb_dsps_of_match[]; 52 53/** 54 * avoid using musb_readx()/musb_writex() as glue layer should not be 55 * dependent on musb core layer symbols. 56 */ 57static inline u8 dsps_readb(const void __iomem *addr, unsigned offset) 58 { return __raw_readb(addr + offset); } 59 60static inline u32 dsps_readl(const void __iomem *addr, unsigned offset) 61 { return __raw_readl(addr + offset); } 62 63static inline void dsps_writeb(void __iomem *addr, unsigned offset, u8 data) 64 { __raw_writeb(data, addr + offset); } 65 66static inline void dsps_writel(void __iomem *addr, unsigned offset, u32 data) 67 { __raw_writel(data, addr + offset); } 68 69/** 70 * DSPS musb wrapper register offset. 71 * FIXME: This should be expanded to have all the wrapper registers from TI DSPS 72 * musb ips. 73 */ 74struct dsps_musb_wrapper { 75 u16 revision; 76 u16 control; 77 u16 status; 78 u16 epintr_set; 79 u16 epintr_clear; 80 u16 epintr_status; 81 u16 coreintr_set; 82 u16 coreintr_clear; 83 u16 coreintr_status; 84 u16 phy_utmi; 85 u16 mode; 86 87 /* bit positions for control */ 88 unsigned reset:5; 89 90 /* bit positions for interrupt */ 91 unsigned usb_shift:5; 92 u32 usb_mask; 93 u32 usb_bitmap; 94 unsigned drvvbus:5; 95 96 unsigned txep_shift:5; 97 u32 txep_mask; 98 u32 txep_bitmap; 99 100 unsigned rxep_shift:5; 101 u32 rxep_mask; 102 u32 rxep_bitmap; 103 104 /* bit positions for phy_utmi */ 105 unsigned otg_disable:5; 106 107 /* bit positions for mode */ 108 unsigned iddig:5; 109 /* miscellaneous stuff */ 110 u8 poll_seconds; 111}; 112 113/** 114 * DSPS glue structure. 115 */ 116struct dsps_glue { 117 struct device *dev; 118 struct platform_device *musb; /* child musb pdev */ 119 const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */ 120 struct timer_list timer; /* otg_workaround timer */ 121 unsigned long last_timer; /* last timer data for each instance */ 122}; 123 124static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout); 125/** 126 * dsps_musb_enable - enable interrupts 127 */ 128static void dsps_musb_enable(struct musb *musb) 129{ 130 struct device *dev = musb->controller; 131 struct platform_device *pdev = to_platform_device(dev->parent); 132 struct dsps_glue *glue = platform_get_drvdata(pdev); 133 const struct dsps_musb_wrapper *wrp = glue->wrp; 134 void __iomem *reg_base = musb->ctrl_base; 135 u32 epmask, coremask; 136 137 /* Workaround: setup IRQs through both register sets. */ 138 epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) | 139 ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift); 140 coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF); 141 142 dsps_writel(reg_base, wrp->epintr_set, epmask); 143 dsps_writel(reg_base, wrp->coreintr_set, coremask); 144 /* Force the DRVVBUS IRQ so we can start polling for ID change. */ 145 dsps_writel(reg_base, wrp->coreintr_set, 146 (1 << wrp->drvvbus) << wrp->usb_shift); 147 dsps_musb_try_idle(musb, 0); 148} 149 150/** 151 * dsps_musb_disable - disable HDRC and flush interrupts 152 */ 153static void dsps_musb_disable(struct musb *musb) 154{ 155 struct device *dev = musb->controller; 156 struct platform_device *pdev = to_platform_device(dev->parent); 157 struct dsps_glue *glue = platform_get_drvdata(pdev); 158 const struct dsps_musb_wrapper *wrp = glue->wrp; 159 void __iomem *reg_base = musb->ctrl_base; 160 161 dsps_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap); 162 dsps_writel(reg_base, wrp->epintr_clear, 163 wrp->txep_bitmap | wrp->rxep_bitmap); 164 dsps_writeb(musb->mregs, MUSB_DEVCTL, 0); 165} 166 167static void otg_timer(unsigned long _musb) 168{ 169 struct musb *musb = (void *)_musb; 170 void __iomem *mregs = musb->mregs; 171 struct device *dev = musb->controller; 172 struct dsps_glue *glue = dev_get_drvdata(dev->parent); 173 const struct dsps_musb_wrapper *wrp = glue->wrp; 174 u8 devctl; 175 unsigned long flags; 176 177 /* 178 * We poll because DSPS IP's won't expose several OTG-critical 179 * status change events (from the transceiver) otherwise. 180 */ 181 devctl = dsps_readb(mregs, MUSB_DEVCTL); 182 dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl, 183 usb_otg_state_string(musb->xceiv->state)); 184 185 spin_lock_irqsave(&musb->lock, flags); 186 switch (musb->xceiv->state) { 187 case OTG_STATE_A_WAIT_BCON: 188 devctl &= ~MUSB_DEVCTL_SESSION; 189 dsps_writeb(musb->mregs, MUSB_DEVCTL, devctl); 190 191 devctl = dsps_readb(musb->mregs, MUSB_DEVCTL); 192 if (devctl & MUSB_DEVCTL_BDEVICE) { 193 musb->xceiv->state = OTG_STATE_B_IDLE; 194 MUSB_DEV_MODE(musb); 195 } else { 196 musb->xceiv->state = OTG_STATE_A_IDLE; 197 MUSB_HST_MODE(musb); 198 } 199 break; 200 case OTG_STATE_A_WAIT_VFALL: 201 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE; 202 dsps_writel(musb->ctrl_base, wrp->coreintr_set, 203 MUSB_INTR_VBUSERROR << wrp->usb_shift); 204 break; 205 case OTG_STATE_B_IDLE: 206 devctl = dsps_readb(mregs, MUSB_DEVCTL); 207 if (devctl & MUSB_DEVCTL_BDEVICE) 208 mod_timer(&glue->timer, 209 jiffies + wrp->poll_seconds * HZ); 210 else 211 musb->xceiv->state = OTG_STATE_A_IDLE; 212 break; 213 default: 214 break; 215 } 216 spin_unlock_irqrestore(&musb->lock, flags); 217} 218 219static void dsps_musb_try_idle(struct musb *musb, unsigned long timeout) 220{ 221 struct device *dev = musb->controller; 222 struct dsps_glue *glue = dev_get_drvdata(dev->parent); 223 224 if (timeout == 0) 225 timeout = jiffies + msecs_to_jiffies(3); 226 227 /* Never idle if active, or when VBUS timeout is not set as host */ 228 if (musb->is_active || (musb->a_wait_bcon == 0 && 229 musb->xceiv->state == OTG_STATE_A_WAIT_BCON)) { 230 dev_dbg(musb->controller, "%s active, deleting timer\n", 231 usb_otg_state_string(musb->xceiv->state)); 232 del_timer(&glue->timer); 233 glue->last_timer = jiffies; 234 return; 235 } 236 if (musb->port_mode == MUSB_PORT_MODE_HOST) 237 return; 238 239 if (!musb->g.dev.driver) 240 return; 241 242 if (time_after(glue->last_timer, timeout) && 243 timer_pending(&glue->timer)) { 244 dev_dbg(musb->controller, 245 "Longer idle timer already pending, ignoring...\n"); 246 return; 247 } 248 glue->last_timer = timeout; 249 250 dev_dbg(musb->controller, "%s inactive, starting idle timer for %u ms\n", 251 usb_otg_state_string(musb->xceiv->state), 252 jiffies_to_msecs(timeout - jiffies)); 253 mod_timer(&glue->timer, timeout); 254} 255 256static irqreturn_t dsps_interrupt(int irq, void *hci) 257{ 258 struct musb *musb = hci; 259 void __iomem *reg_base = musb->ctrl_base; 260 struct device *dev = musb->controller; 261 struct dsps_glue *glue = dev_get_drvdata(dev->parent); 262 const struct dsps_musb_wrapper *wrp = glue->wrp; 263 unsigned long flags; 264 irqreturn_t ret = IRQ_NONE; 265 u32 epintr, usbintr; 266 267 spin_lock_irqsave(&musb->lock, flags); 268 269 /* Get endpoint interrupts */ 270 epintr = dsps_readl(reg_base, wrp->epintr_status); 271 musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift; 272 musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift; 273 274 if (epintr) 275 dsps_writel(reg_base, wrp->epintr_status, epintr); 276 277 /* Get usb core interrupts */ 278 usbintr = dsps_readl(reg_base, wrp->coreintr_status); 279 if (!usbintr && !epintr) 280 goto out; 281 282 musb->int_usb = (usbintr & wrp->usb_bitmap) >> wrp->usb_shift; 283 if (usbintr) 284 dsps_writel(reg_base, wrp->coreintr_status, usbintr); 285 286 dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n", 287 usbintr, epintr); 288 /* 289 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for 290 * DSPS IP's missing ID change IRQ. We need an ID change IRQ to 291 * switch appropriately between halves of the OTG state machine. 292 * Managing DEVCTL.SESSION per Mentor docs requires that we know its 293 * value but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set. 294 * Also, DRVVBUS pulses for SRP (but not at 5V) ... 295 */ 296 if (is_host_active(musb) && usbintr & MUSB_INTR_BABBLE) 297 pr_info("CAUTION: musb: Babble Interrupt Occurred\n"); 298 299 if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) { 300 int drvvbus = dsps_readl(reg_base, wrp->status); 301 void __iomem *mregs = musb->mregs; 302 u8 devctl = dsps_readb(mregs, MUSB_DEVCTL); 303 int err; 304 305 err = musb->int_usb & MUSB_INTR_VBUSERROR; 306 if (err) { 307 /* 308 * The Mentor core doesn't debounce VBUS as needed 309 * to cope with device connect current spikes. This 310 * means it's not uncommon for bus-powered devices 311 * to get VBUS errors during enumeration. 312 * 313 * This is a workaround, but newer RTL from Mentor 314 * seems to allow a better one: "re"-starting sessions 315 * without waiting for VBUS to stop registering in 316 * devctl. 317 */ 318 musb->int_usb &= ~MUSB_INTR_VBUSERROR; 319 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL; 320 mod_timer(&glue->timer, 321 jiffies + wrp->poll_seconds * HZ); 322 WARNING("VBUS error workaround (delay coming)\n"); 323 } else if (drvvbus) { 324 MUSB_HST_MODE(musb); 325 musb->xceiv->otg->default_a = 1; 326 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE; 327 del_timer(&glue->timer); 328 } else { 329 musb->is_active = 0; 330 MUSB_DEV_MODE(musb); 331 musb->xceiv->otg->default_a = 0; 332 musb->xceiv->state = OTG_STATE_B_IDLE; 333 } 334 335 /* NOTE: this must complete power-on within 100 ms. */ 336 dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n", 337 drvvbus ? "on" : "off", 338 usb_otg_state_string(musb->xceiv->state), 339 err ? " ERROR" : "", 340 devctl); 341 ret = IRQ_HANDLED; 342 } 343 344 if (musb->int_tx || musb->int_rx || musb->int_usb) 345 ret |= musb_interrupt(musb); 346 347 /* Poll for ID change */ 348 if (musb->xceiv->state == OTG_STATE_B_IDLE) 349 mod_timer(&glue->timer, jiffies + wrp->poll_seconds * HZ); 350out: 351 spin_unlock_irqrestore(&musb->lock, flags); 352 353 return ret; 354} 355 356static int dsps_musb_init(struct musb *musb) 357{ 358 struct device *dev = musb->controller; 359 struct dsps_glue *glue = dev_get_drvdata(dev->parent); 360 struct platform_device *parent = to_platform_device(dev->parent); 361 const struct dsps_musb_wrapper *wrp = glue->wrp; 362 void __iomem *reg_base; 363 struct resource *r; 364 u32 rev, val; 365 366 r = platform_get_resource_byname(parent, IORESOURCE_MEM, "control"); 367 if (!r) 368 return -EINVAL; 369 370 reg_base = devm_ioremap_resource(dev, r); 371 if (IS_ERR(reg_base)) 372 return PTR_ERR(reg_base); 373 musb->ctrl_base = reg_base; 374 375 /* NOP driver needs change if supporting dual instance */ 376 musb->xceiv = devm_usb_get_phy_by_phandle(dev, "phys", 0); 377 if (IS_ERR(musb->xceiv)) 378 return PTR_ERR(musb->xceiv); 379 380 /* Returns zero if e.g. not clocked */ 381 rev = dsps_readl(reg_base, wrp->revision); 382 if (!rev) 383 return -ENODEV; 384 385 usb_phy_init(musb->xceiv); 386 setup_timer(&glue->timer, otg_timer, (unsigned long) musb); 387 388 /* Reset the musb */ 389 dsps_writel(reg_base, wrp->control, (1 << wrp->reset)); 390 391 musb->isr = dsps_interrupt; 392 393 /* reset the otgdisable bit, needed for host mode to work */ 394 val = dsps_readl(reg_base, wrp->phy_utmi); 395 val &= ~(1 << wrp->otg_disable); 396 dsps_writel(musb->ctrl_base, wrp->phy_utmi, val); 397 398 return 0; 399} 400 401static int dsps_musb_exit(struct musb *musb) 402{ 403 struct device *dev = musb->controller; 404 struct dsps_glue *glue = dev_get_drvdata(dev->parent); 405 406 del_timer_sync(&glue->timer); 407 408 usb_phy_shutdown(musb->xceiv); 409 return 0; 410} 411 412static struct musb_platform_ops dsps_ops = { 413 .init = dsps_musb_init, 414 .exit = dsps_musb_exit, 415 416 .enable = dsps_musb_enable, 417 .disable = dsps_musb_disable, 418 419 .try_idle = dsps_musb_try_idle, 420}; 421 422static u64 musb_dmamask = DMA_BIT_MASK(32); 423 424static int get_int_prop(struct device_node *dn, const char *s) 425{ 426 int ret; 427 u32 val; 428 429 ret = of_property_read_u32(dn, s, &val); 430 if (ret) 431 return 0; 432 return val; 433} 434 435static int get_musb_port_mode(struct device *dev) 436{ 437 enum usb_dr_mode mode; 438 439 mode = of_usb_get_dr_mode(dev->of_node); 440 switch (mode) { 441 case USB_DR_MODE_HOST: 442 return MUSB_PORT_MODE_HOST; 443 444 case USB_DR_MODE_PERIPHERAL: 445 return MUSB_PORT_MODE_GADGET; 446 447 case USB_DR_MODE_UNKNOWN: 448 case USB_DR_MODE_OTG: 449 default: 450 return MUSB_PORT_MODE_DUAL_ROLE; 451 }; 452} 453 454static int dsps_create_musb_pdev(struct dsps_glue *glue, 455 struct platform_device *parent) 456{ 457 struct musb_hdrc_platform_data pdata; 458 struct resource resources[2]; 459 struct resource *res; 460 struct device *dev = &parent->dev; 461 struct musb_hdrc_config *config; 462 struct platform_device *musb; 463 struct device_node *dn = parent->dev.of_node; 464 int ret; 465 466 memset(resources, 0, sizeof(resources)); 467 res = platform_get_resource_byname(parent, IORESOURCE_MEM, "mc"); 468 if (!res) { 469 dev_err(dev, "failed to get memory.\n"); 470 return -EINVAL; 471 } 472 resources[0] = *res; 473 474 res = platform_get_resource_byname(parent, IORESOURCE_IRQ, "mc"); 475 if (!res) { 476 dev_err(dev, "failed to get irq.\n"); 477 return -EINVAL; 478 } 479 resources[1] = *res; 480 481 /* allocate the child platform device */ 482 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO); 483 if (!musb) { 484 dev_err(dev, "failed to allocate musb device\n"); 485 return -ENOMEM; 486 } 487 488 musb->dev.parent = dev; 489 musb->dev.dma_mask = &musb_dmamask; 490 musb->dev.coherent_dma_mask = musb_dmamask; 491 musb->dev.of_node = of_node_get(dn); 492 493 glue->musb = musb; 494 495 ret = platform_device_add_resources(musb, resources, 496 ARRAY_SIZE(resources)); 497 if (ret) { 498 dev_err(dev, "failed to add resources\n"); 499 goto err; 500 } 501 502 config = devm_kzalloc(&parent->dev, sizeof(*config), GFP_KERNEL); 503 if (!config) { 504 dev_err(dev, "failed to allocate musb hdrc config\n"); 505 ret = -ENOMEM; 506 goto err; 507 } 508 pdata.config = config; 509 pdata.platform_ops = &dsps_ops; 510 511 config->num_eps = get_int_prop(dn, "mentor,num-eps"); 512 config->ram_bits = get_int_prop(dn, "mentor,ram-bits"); 513 pdata.mode = get_musb_port_mode(dev); 514 /* DT keeps this entry in mA, musb expects it as per USB spec */ 515 pdata.power = get_int_prop(dn, "mentor,power") / 2; 516 config->multipoint = of_property_read_bool(dn, "mentor,multipoint"); 517 518 ret = platform_device_add_data(musb, &pdata, sizeof(pdata)); 519 if (ret) { 520 dev_err(dev, "failed to add platform_data\n"); 521 goto err; 522 } 523 524 ret = platform_device_add(musb); 525 if (ret) { 526 dev_err(dev, "failed to register musb device\n"); 527 goto err; 528 } 529 return 0; 530 531err: 532 platform_device_put(musb); 533 return ret; 534} 535 536static int dsps_probe(struct platform_device *pdev) 537{ 538 const struct of_device_id *match; 539 const struct dsps_musb_wrapper *wrp; 540 struct dsps_glue *glue; 541 int ret; 542 543 match = of_match_node(musb_dsps_of_match, pdev->dev.of_node); 544 if (!match) { 545 dev_err(&pdev->dev, "fail to get matching of_match struct\n"); 546 return -EINVAL; 547 } 548 wrp = match->data; 549 550 /* allocate glue */ 551 glue = kzalloc(sizeof(*glue), GFP_KERNEL); 552 if (!glue) { 553 dev_err(&pdev->dev, "unable to allocate glue memory\n"); 554 return -ENOMEM; 555 } 556 557 glue->dev = &pdev->dev; 558 glue->wrp = wrp; 559 560 platform_set_drvdata(pdev, glue); 561 pm_runtime_enable(&pdev->dev); 562 563 ret = pm_runtime_get_sync(&pdev->dev); 564 if (ret < 0) { 565 dev_err(&pdev->dev, "pm_runtime_get_sync FAILED"); 566 goto err2; 567 } 568 569 ret = dsps_create_musb_pdev(glue, pdev); 570 if (ret) 571 goto err3; 572 573 return 0; 574 575err3: 576 pm_runtime_put(&pdev->dev); 577err2: 578 pm_runtime_disable(&pdev->dev); 579 kfree(glue); 580 return ret; 581} 582 583static int dsps_remove(struct platform_device *pdev) 584{ 585 struct dsps_glue *glue = platform_get_drvdata(pdev); 586 587 platform_device_unregister(glue->musb); 588 589 /* disable usbss clocks */ 590 pm_runtime_put(&pdev->dev); 591 pm_runtime_disable(&pdev->dev); 592 kfree(glue); 593 return 0; 594} 595 596static const struct dsps_musb_wrapper am33xx_driver_data = { 597 .revision = 0x00, 598 .control = 0x14, 599 .status = 0x18, 600 .epintr_set = 0x38, 601 .epintr_clear = 0x40, 602 .epintr_status = 0x30, 603 .coreintr_set = 0x3c, 604 .coreintr_clear = 0x44, 605 .coreintr_status = 0x34, 606 .phy_utmi = 0xe0, 607 .mode = 0xe8, 608 .reset = 0, 609 .otg_disable = 21, 610 .iddig = 8, 611 .usb_shift = 0, 612 .usb_mask = 0x1ff, 613 .usb_bitmap = (0x1ff << 0), 614 .drvvbus = 8, 615 .txep_shift = 0, 616 .txep_mask = 0xffff, 617 .txep_bitmap = (0xffff << 0), 618 .rxep_shift = 16, 619 .rxep_mask = 0xfffe, 620 .rxep_bitmap = (0xfffe << 16), 621 .poll_seconds = 2, 622}; 623 624static const struct of_device_id musb_dsps_of_match[] = { 625 { .compatible = "ti,musb-am33xx", 626 .data = (void *) &am33xx_driver_data, }, 627 { }, 628}; 629MODULE_DEVICE_TABLE(of, musb_dsps_of_match); 630 631static struct platform_driver dsps_usbss_driver = { 632 .probe = dsps_probe, 633 .remove = dsps_remove, 634 .driver = { 635 .name = "musb-dsps", 636 .of_match_table = musb_dsps_of_match, 637 }, 638}; 639 640MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer"); 641MODULE_AUTHOR("Ravi B <ravibabu@ti.com>"); 642MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>"); 643MODULE_LICENSE("GPL v2"); 644 645module_platform_driver(dsps_usbss_driver); 646