drivers/usb/chipidea/core.c

   1 /*
   2  * core.c - ChipIdea USB IP core family device controller
   3  *
   4  * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
   5  *
   6  * Author: David Lopo
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 /*
  14  * Description: ChipIdea USB IP core family device controller
  15  *
  16  * This driver is composed of several blocks:
  17  * - HW:     hardware interface
  18  * - DBG:    debug facilities (optional)
  19  * - UTIL:   utilities
  20  * - ISR:    interrupts handling
  21  * - ENDPT:  endpoint operations (Gadget API)
  22  * - GADGET: gadget operations (Gadget API)
  23  * - BUS:    bus glue code, bus abstraction layer
  24  *
  25  * Compile Options
  26  * - CONFIG_USB_GADGET_DEBUG_FILES: enable debug facilities
  27  * - STALL_IN:  non-empty bulk-in pipes cannot be halted
  28  *              if defined mass storage compliance succeeds but with warnings
  29  *              => case 4: Hi >  Dn
  30  *              => case 5: Hi >  Di
  31  *              => case 8: Hi <> Do
  32  *              if undefined usbtest 13 fails
  33  * - TRACE:     enable function tracing (depends on DEBUG)
  34  *
  35  * Main Features
  36  * - Chapter 9 & Mass Storage Compliance with Gadget File Storage
  37  * - Chapter 9 Compliance with Gadget Zero (STALL_IN undefined)
  38  * - Normal & LPM support
  39  *
  40  * USBTEST Report
  41  * - OK: 0-12, 13 (STALL_IN defined) & 14
  42  * - Not Supported: 15 & 16 (ISO)
  43  *
  44  * TODO List
  45  * - OTG
  46  * - Interrupt Traffic
  47  * - GET_STATUS(device) - always reports 0
  48  * - Gadget API (majority of optional features)
  49  * - Suspend & Remote Wakeup
  50  */
  51 #include <linux/delay.h>
  52 #include <linux/device.h>
  53 #include <linux/dma-mapping.h>
  54 #include <linux/platform_device.h>
  55 #include <linux/module.h>
  56 #include <linux/idr.h>
  57 #include <linux/interrupt.h>
  58 #include <linux/io.h>
  59 #include <linux/kernel.h>
  60 #include <linux/slab.h>
  61 #include <linux/pm_runtime.h>
  62 #include <linux/usb/ch9.h>
  63 #include <linux/usb/gadget.h>
  64 #include <linux/usb/otg.h>
  65 #include <linux/usb/chipidea.h>
  66 #include <linux/usb/of.h>
  67 #include <linux/phy.h>
  68
  69 #include "ci.h"
  70 #include "udc.h"
  71 #include "bits.h"
  72 #include "host.h"
  73 #include "debug.h"
  74
  75 /* Controller register map */
  76 static uintptr_t ci_regs_nolpm[] = {
  77         [CAP_CAPLENGTH]         = 0x000UL,
  78         [CAP_HCCPARAMS]         = 0x008UL,
  79         [CAP_DCCPARAMS]         = 0x024UL,
  80         [CAP_TESTMODE]          = 0x038UL,
  81         [OP_USBCMD]             = 0x000UL,
  82         [OP_USBSTS]             = 0x004UL,
  83         [OP_USBINTR]            = 0x008UL,
  84         [OP_DEVICEADDR]         = 0x014UL,
  85         [OP_ENDPTLISTADDR]      = 0x018UL,
  86         [OP_PORTSC]             = 0x044UL,
  87         [OP_DEVLC]              = 0x084UL,
  88         [OP_OTGSC]              = 0x064UL,
  89         [OP_USBMODE]            = 0x068UL,
  90         [OP_ENDPTSETUPSTAT]     = 0x06CUL,
  91         [OP_ENDPTPRIME]         = 0x070UL,
  92         [OP_ENDPTFLUSH]         = 0x074UL,
  93         [OP_ENDPTSTAT]          = 0x078UL,
  94         [OP_ENDPTCOMPLETE]      = 0x07CUL,
  95         [OP_ENDPTCTRL]          = 0x080UL,
  96 };
  97
  98 static uintptr_t ci_regs_lpm[] = {
  99         [CAP_CAPLENGTH]         = 0x000UL,
 100         [CAP_HCCPARAMS]         = 0x008UL,
 101         [CAP_DCCPARAMS]         = 0x024UL,
 102         [CAP_TESTMODE]          = 0x0FCUL,
 103         [OP_USBCMD]             = 0x000UL,
 104         [OP_USBSTS]             = 0x004UL,
 105         [OP_USBINTR]            = 0x008UL,
 106         [OP_DEVICEADDR]         = 0x014UL,
 107         [OP_ENDPTLISTADDR]      = 0x018UL,
 108         [OP_PORTSC]             = 0x044UL,
 109         [OP_DEVLC]              = 0x084UL,
 110         [OP_OTGSC]              = 0x0C4UL,
 111         [OP_USBMODE]            = 0x0C8UL,
 112         [OP_ENDPTSETUPSTAT]     = 0x0D8UL,
 113         [OP_ENDPTPRIME]         = 0x0DCUL,
 114         [OP_ENDPTFLUSH]         = 0x0E0UL,
 115         [OP_ENDPTSTAT]          = 0x0E4UL,
 116         [OP_ENDPTCOMPLETE]      = 0x0E8UL,
 117         [OP_ENDPTCTRL]          = 0x0ECUL,
 118 };
 119
 120 static int hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm)
 121 {
 122         int i;
 123
 124         kfree(ci->hw_bank.regmap);
 125
 126         ci->hw_bank.regmap = kzalloc((OP_LAST + 1) * sizeof(void *),
 127                                      GFP_KERNEL);
 128         if (!ci->hw_bank.regmap)
 129                 return -ENOMEM;
 130
 131         for (i = 0; i < OP_ENDPTCTRL; i++)
 132                 ci->hw_bank.regmap[i] =
 133                         (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
 134                         (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
 135
 136         for (; i <= OP_LAST; i++)
 137                 ci->hw_bank.regmap[i] = ci->hw_bank.op +
 138                         4 * (i - OP_ENDPTCTRL) +
 139                         (is_lpm
 140                          ? ci_regs_lpm[OP_ENDPTCTRL]
 141                          : ci_regs_nolpm[OP_ENDPTCTRL]);
 142
 143         return 0;
 144 }
 145
 146 /**
 147  * hw_port_test_set: writes port test mode (execute without interruption)
 148  * @mode: new value
 149  *
 150  * This function returns an error code
 151  */
 152 int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
 153 {
 154         const u8 TEST_MODE_MAX = 7;
 155
 156         if (mode > TEST_MODE_MAX)
 157                 return -EINVAL;
 158
 159         hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
 160         return 0;
 161 }
 162
 163 /**
 164  * hw_port_test_get: reads port test mode value
 165  *
 166  * This function returns port test mode value
 167  */
 168 u8 hw_port_test_get(struct ci_hdrc *ci)
 169 {
 170         return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
 171 }
 172
 173 static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
 174 {
 175         u32 reg;
 176
 177         /* bank is a module variable */
 178         ci->hw_bank.abs = base;
 179
 180         ci->hw_bank.cap = ci->hw_bank.abs;
 181         ci->hw_bank.cap += ci->platdata->capoffset;
 182         ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
 183
 184         hw_alloc_regmap(ci, false);
 185         reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
 186                 __ffs(HCCPARAMS_LEN);
 187         ci->hw_bank.lpm  = reg;
 188         hw_alloc_regmap(ci, !!reg);
 189         ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
 190         ci->hw_bank.size += OP_LAST;
 191         ci->hw_bank.size /= sizeof(u32);
 192
 193         reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
 194                 __ffs(DCCPARAMS_DEN);
 195         ci->hw_ep_max = reg * 2;   /* cache hw ENDPT_MAX */
 196
 197         if (ci->hw_ep_max > ENDPT_MAX)
 198                 return -ENODEV;
 199
 200         dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
 201                 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
 202
 203         /* setup lock mode ? */
 204
 205         /* ENDPTSETUPSTAT is '0' by default */
 206
 207         /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
 208
 209         return 0;
 210 }
 211
 212 static void hw_phymode_configure(struct ci_hdrc *ci)
 213 {
 214         u32 portsc, lpm, sts;
 215
 216         switch (ci->platdata->phy_mode) {
 217         case USBPHY_INTERFACE_MODE_UTMI:
 218                 portsc = PORTSC_PTS(PTS_UTMI);
 219                 lpm = DEVLC_PTS(PTS_UTMI);
 220                 break;
 221         case USBPHY_INTERFACE_MODE_UTMIW:
 222                 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
 223                 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
 224                 break;
 225         case USBPHY_INTERFACE_MODE_ULPI:
 226                 portsc = PORTSC_PTS(PTS_ULPI);
 227                 lpm = DEVLC_PTS(PTS_ULPI);
 228                 break;
 229         case USBPHY_INTERFACE_MODE_SERIAL:
 230                 portsc = PORTSC_PTS(PTS_SERIAL);
 231                 lpm = DEVLC_PTS(PTS_SERIAL);
 232                 sts = 1;
 233                 break;
 234         case USBPHY_INTERFACE_MODE_HSIC:
 235                 portsc = PORTSC_PTS(PTS_HSIC);
 236                 lpm = DEVLC_PTS(PTS_HSIC);
 237                 break;
 238         default:
 239                 return;
 240         }
 241
 242         if (ci->hw_bank.lpm) {
 243                 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
 244                 hw_write(ci, OP_DEVLC, DEVLC_STS, sts);
 245         } else {
 246                 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
 247                 hw_write(ci, OP_PORTSC, PORTSC_STS, sts);
 248         }
 249 }
 250
 251 /**
 252  * hw_device_reset: resets chip (execute without interruption)
 253  * @ci: the controller
 254   *
 255  * This function returns an error code
 256  */
 257 int hw_device_reset(struct ci_hdrc *ci, u32 mode)
 258 {
 259         /* should flush & stop before reset */
 260         hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
 261         hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
 262
 263         hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
 264         while (hw_read(ci, OP_USBCMD, USBCMD_RST))
 265                 udelay(10);             /* not RTOS friendly */
 266
 267         if (ci->platdata->notify_event)
 268                 ci->platdata->notify_event(ci,
 269                         CI_HDRC_CONTROLLER_RESET_EVENT);
 270
 271         if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
 272                 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
 273
 274         /* USBMODE should be configured step by step */
 275         hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
 276         hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
 277         /* HW >= 2.3 */
 278         hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
 279
 280         if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
 281                 pr_err("cannot enter in %s mode", ci_role(ci)->name);
 282                 pr_err("lpm = %i", ci->hw_bank.lpm);
 283                 return -ENODEV;
 284         }
 285
 286         return 0;
 287 }
 288
 289 /**
 290  * ci_otg_role - pick role based on ID pin state
 291  * @ci: the controller
 292  */
 293 static enum ci_role ci_otg_role(struct ci_hdrc *ci)
 294 {
 295         u32 sts = hw_read(ci, OP_OTGSC, ~0);
 296         enum ci_role role = sts & OTGSC_ID
 297                 ? CI_ROLE_GADGET
 298                 : CI_ROLE_HOST;
 299
 300         return role;
 301 }
 302
 303 /**
 304  * ci_role_work - perform role changing based on ID pin
 305  * @work: work struct
 306  */
 307 static void ci_role_work(struct work_struct *work)
 308 {
 309         struct ci_hdrc *ci = container_of(work, struct ci_hdrc, work);
 310         enum ci_role role = ci_otg_role(ci);
 311
 312         if (role != ci->role) {
 313                 dev_dbg(ci->dev, "switching from %s to %s\n",
 314                         ci_role(ci)->name, ci->roles[role]->name);
 315
 316                 ci_role_stop(ci);
 317                 ci_role_start(ci, role);
 318         }
 319
 320         enable_irq(ci->irq);
 321 }
 322
 323 static irqreturn_t ci_irq(int irq, void *data)
 324 {
 325         struct ci_hdrc *ci = data;
 326         irqreturn_t ret = IRQ_NONE;
 327         u32 otgsc = 0;
 328
 329         if (ci->is_otg)
 330                 otgsc = hw_read(ci, OP_OTGSC, ~0);
 331
 332         if (ci->role != CI_ROLE_END)
 333                 ret = ci_role(ci)->irq(ci);
 334
 335         if (ci->is_otg && (otgsc & OTGSC_IDIS)) {
 336                 hw_write(ci, OP_OTGSC, OTGSC_IDIS, OTGSC_IDIS);
 337                 disable_irq_nosync(ci->irq);
 338                 queue_work(ci->wq, &ci->work);
 339                 ret = IRQ_HANDLED;
 340         }
 341
 342         return ret;
 343 }
 344
 345 static DEFINE_IDA(ci_ida);
 346
 347 struct platform_device *ci_hdrc_add_device(struct device *dev,
 348                         struct resource *res, int nres,
 349                         struct ci_hdrc_platform_data *platdata)
 350 {
 351         struct platform_device *pdev;
 352         int id, ret;
 353
 354         id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
 355         if (id < 0)
 356                 return ERR_PTR(id);
 357
 358         pdev = platform_device_alloc("ci_hdrc", id);
 359         if (!pdev) {
 360                 ret = -ENOMEM;
 361                 goto put_id;
 362         }
 363
 364         pdev->dev.parent = dev;
 365         pdev->dev.dma_mask = dev->dma_mask;
 366         pdev->dev.dma_parms = dev->dma_parms;
 367         dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
 368
 369         ret = platform_device_add_resources(pdev, res, nres);
 370         if (ret)
 371                 goto err;
 372
 373         ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
 374         if (ret)
 375                 goto err;
 376
 377         ret = platform_device_add(pdev);
 378         if (ret)
 379                 goto err;
 380
 381         return pdev;
 382
 383 err:
 384         platform_device_put(pdev);
 385 put_id:
 386         ida_simple_remove(&ci_ida, id);
 387         return ERR_PTR(ret);
 388 }
 389 EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
 390
 391 void ci_hdrc_remove_device(struct platform_device *pdev)
 392 {
 393         int id = pdev->id;
 394         platform_device_unregister(pdev);
 395         ida_simple_remove(&ci_ida, id);
 396 }
 397 EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
 398
 399 static int ci_hdrc_probe(struct platform_device *pdev)
 400 {
 401         struct device   *dev = &pdev->dev;
 402         struct ci_hdrc  *ci;
 403         struct resource *res;
 404         void __iomem    *base;
 405         int             ret;
 406         enum usb_dr_mode dr_mode;
 407         struct device_node *of_node = dev->of_node ?: dev->parent->of_node;
 408
 409         if (!dev->platform_data) {
 410                 dev_err(dev, "platform data missing\n");
 411                 return -ENODEV;
 412         }
 413
 414         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 415         base = devm_ioremap_resource(dev, res);
 416         if (IS_ERR(base))
 417                 return PTR_ERR(base);
 418
 419         ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
 420         if (!ci) {
 421                 dev_err(dev, "can't allocate device\n");
 422                 return -ENOMEM;
 423         }
 424
 425         ci->dev = dev;
 426         ci->platdata = dev->platform_data;
 427         if (ci->platdata->phy)
 428                 ci->transceiver = ci->platdata->phy;
 429         else
 430                 ci->global_phy = true;
 431
 432         ret = hw_device_init(ci, base);
 433         if (ret < 0) {
 434                 dev_err(dev, "can't initialize hardware\n");
 435                 return -ENODEV;
 436         }
 437
 438         ci->hw_bank.phys = res->start;
 439
 440         ci->irq = platform_get_irq(pdev, 0);
 441         if (ci->irq < 0) {
 442                 dev_err(dev, "missing IRQ\n");
 443                 return -ENODEV;
 444         }
 445
 446         INIT_WORK(&ci->work, ci_role_work);
 447         ci->wq = create_singlethread_workqueue("ci_otg");
 448         if (!ci->wq) {
 449                 dev_err(dev, "can't create workqueue\n");
 450                 return -ENODEV;
 451         }
 452
 453         if (!ci->platdata->phy_mode)
 454                 ci->platdata->phy_mode = of_usb_get_phy_mode(of_node);
 455
 456         hw_phymode_configure(ci);
 457
 458         if (!ci->platdata->dr_mode)
 459                 ci->platdata->dr_mode = of_usb_get_dr_mode(of_node);
 460
 461         if (ci->platdata->dr_mode == USB_DR_MODE_UNKNOWN)
 462                 ci->platdata->dr_mode = USB_DR_MODE_OTG;
 463
 464         dr_mode = ci->platdata->dr_mode;
 465         /* initialize role(s) before the interrupt is requested */
 466         if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
 467                 ret = ci_hdrc_host_init(ci);
 468                 if (ret)
 469                         dev_info(dev, "doesn't support host\n");
 470         }
 471
 472         if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
 473                 ret = ci_hdrc_gadget_init(ci);
 474                 if (ret)
 475                         dev_info(dev, "doesn't support gadget\n");
 476         }
 477
 478         if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
 479                 dev_err(dev, "no supported roles\n");
 480                 ret = -ENODEV;
 481                 goto rm_wq;
 482         }
 483
 484         if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
 485                 ci->is_otg = true;
 486                 /* ID pin needs 1ms debouce time, we delay 2ms for safe */
 487                 mdelay(2);
 488                 ci->role = ci_otg_role(ci);
 489         } else {
 490                 ci->role = ci->roles[CI_ROLE_HOST]
 491                         ? CI_ROLE_HOST
 492                         : CI_ROLE_GADGET;
 493         }
 494
 495         ret = ci_role_start(ci, ci->role);
 496         if (ret) {
 497                 dev_err(dev, "can't start %s role\n", ci_role(ci)->name);
 498                 goto rm_wq;
 499         }
 500
 501         platform_set_drvdata(pdev, ci);
 502         ret = request_irq(ci->irq, ci_irq, IRQF_SHARED, ci->platdata->name,
 503                           ci);
 504         if (ret)
 505                 goto stop;
 506
 507         if (ci->is_otg)
 508                 hw_write(ci, OP_OTGSC, OTGSC_IDIE, OTGSC_IDIE);
 509
 510         ret = dbg_create_files(ci);
 511         if (!ret)
 512                 return 0;
 513
 514         free_irq(ci->irq, ci);
 515 stop:
 516         ci_role_stop(ci);
 517 rm_wq:
 518         flush_workqueue(ci->wq);
 519         destroy_workqueue(ci->wq);
 520
 521         return ret;
 522 }
 523
 524 static int ci_hdrc_remove(struct platform_device *pdev)
 525 {
 526         struct ci_hdrc *ci = platform_get_drvdata(pdev);
 527
 528         dbg_remove_files(ci);
 529         flush_workqueue(ci->wq);
 530         destroy_workqueue(ci->wq);
 531         free_irq(ci->irq, ci);
 532         ci_role_stop(ci);
 533
 534         return 0;
 535 }
 536
 537 static struct platform_driver ci_hdrc_driver = {
 538         .probe  = ci_hdrc_probe,
 539         .remove = ci_hdrc_remove,
 540         .driver = {
 541                 .name   = "ci_hdrc",
 542         },
 543 };
 544
 545 module_platform_driver(ci_hdrc_driver);
 546
 547 MODULE_ALIAS("platform:ci_hdrc");
 548 MODULE_LICENSE("GPL v2");
 549 MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
 550 MODULE_DESCRIPTION("ChipIdea HDRC Driver");