drivers/usb/renesas_usbhs/common.c

   1 /*
   2  * Renesas USB driver
   3  *
   4  * Copyright (C) 2011 Renesas Solutions Corp.
   5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License
  13  * along with this program; if not, write to the Free Software
  14  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  15  *
  16  */
  17 #include <linux/io.h>
  18 #include <linux/module.h>
  19 #include <linux/pm_runtime.h>
  20 #include <linux/slab.h>
  21 #include <linux/sysfs.h>
  22 #include "common.h"
  23
  24 /*
  25  *              image of renesas_usbhs
  26  *
  27  * ex) gadget case
  28
  29  * mod.c
  30  * mod_gadget.c
  31  * mod_host.c           pipe.c          fifo.c
  32  *
  33  *                      +-------+       +-----------+
  34  *                      | pipe0 |------>| fifo pio  |
  35  * +------------+       +-------+       +-----------+
  36  * | mod_gadget |=====> | pipe1 |--+
  37  * +------------+       +-------+  |    +-----------+
  38  *                      | pipe2 |  |  +-| fifo dma0 |
  39  * +------------+       +-------+  |  | +-----------+
  40  * | mod_host   |       | pipe3 |<-|--+
  41  * +------------+       +-------+  |    +-----------+
  42  *                      | ....  |  +--->| fifo dma1 |
  43  *                      | ....  |       +-----------+
  44  */
  45
  46
  47 #define USBHSF_RUNTIME_PWCTRL   (1 << 0)
  48
  49 /* status */
  50 #define usbhsc_flags_init(p)   do {(p)->flags = 0; } while (0)
  51 #define usbhsc_flags_set(p, b) ((p)->flags |=  (b))
  52 #define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
  53 #define usbhsc_flags_has(p, b) ((p)->flags &   (b))
  54
  55 /*
  56  * platform call back
  57  *
  58  * renesas usb support platform callback function.
  59  * Below macro call it.
  60  * if platform doesn't have callback, it return 0 (no error)
  61  */
  62 #define usbhs_platform_call(priv, func, args...)\
  63         (!(priv) ? -ENODEV :                    \
  64          !((priv)->pfunc.func) ? 0 :            \
  65          (priv)->pfunc.func(args))
  66
  67 /*
  68  *              common functions
  69  */
  70 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
  71 {
  72         return ioread16(priv->base + reg);
  73 }
  74
  75 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
  76 {
  77         iowrite16(data, priv->base + reg);
  78 }
  79
  80 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
  81 {
  82         u16 val = usbhs_read(priv, reg);
  83
  84         val &= ~mask;
  85         val |= data & mask;
  86
  87         usbhs_write(priv, reg, val);
  88 }
  89
  90 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
  91 {
  92         return dev_get_drvdata(&pdev->dev);
  93 }
  94
  95 /*
  96  *              syscfg functions
  97  */
  98 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
  99 {
 100         usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
 101 }
 102
 103 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
 104 {
 105         u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
 106         u16 val  = DCFM | DRPD | HSE | USBE;
 107         int has_otg = usbhs_get_dparam(priv, has_otg);
 108
 109         if (has_otg)
 110                 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
 111
 112         /*
 113          * if enable
 114          *
 115          * - select Host mode
 116          * - D+ Line/D- Line Pull-down
 117          */
 118         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
 119 }
 120
 121 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
 122 {
 123         u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
 124         u16 val  = DPRPU | HSE | USBE;
 125
 126         /*
 127          * if enable
 128          *
 129          * - select Function mode
 130          * - D+ Line Pull-up
 131          */
 132         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
 133 }
 134
 135 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
 136 {
 137         usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
 138 }
 139
 140 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
 141 {
 142         usbhs_write(priv, TESTMODE, mode);
 143 }
 144
 145 /*
 146  *              frame functions
 147  */
 148 int usbhs_frame_get_num(struct usbhs_priv *priv)
 149 {
 150         return usbhs_read(priv, FRMNUM) & FRNM_MASK;
 151 }
 152
 153 /*
 154  *              usb request functions
 155  */
 156 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
 157 {
 158         u16 val;
 159
 160         val = usbhs_read(priv, USBREQ);
 161         req->bRequest           = (val >> 8) & 0xFF;
 162         req->bRequestType       = (val >> 0) & 0xFF;
 163
 164         req->wValue     = usbhs_read(priv, USBVAL);
 165         req->wIndex     = usbhs_read(priv, USBINDX);
 166         req->wLength    = usbhs_read(priv, USBLENG);
 167 }
 168
 169 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
 170 {
 171         usbhs_write(priv, USBREQ,  (req->bRequest << 8) | req->bRequestType);
 172         usbhs_write(priv, USBVAL,  req->wValue);
 173         usbhs_write(priv, USBINDX, req->wIndex);
 174         usbhs_write(priv, USBLENG, req->wLength);
 175
 176         usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
 177 }
 178
 179 /*
 180  *              bus/vbus functions
 181  */
 182 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
 183 {
 184         u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
 185
 186         if (status != USBRST) {
 187                 struct device *dev = usbhs_priv_to_dev(priv);
 188                 dev_err(dev, "usbhs should be reset\n");
 189         }
 190
 191         usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
 192 }
 193
 194 void usbhs_bus_send_reset(struct usbhs_priv *priv)
 195 {
 196         usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
 197 }
 198
 199 int usbhs_bus_get_speed(struct usbhs_priv *priv)
 200 {
 201         u16 dvstctr = usbhs_read(priv, DVSTCTR);
 202
 203         switch (RHST & dvstctr) {
 204         case RHST_LOW_SPEED:
 205                 return USB_SPEED_LOW;
 206         case RHST_FULL_SPEED:
 207                 return USB_SPEED_FULL;
 208         case RHST_HIGH_SPEED:
 209                 return USB_SPEED_HIGH;
 210         }
 211
 212         return USB_SPEED_UNKNOWN;
 213 }
 214
 215 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
 216 {
 217         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 218
 219         return usbhs_platform_call(priv, set_vbus, pdev, enable);
 220 }
 221
 222 static void usbhsc_bus_init(struct usbhs_priv *priv)
 223 {
 224         usbhs_write(priv, DVSTCTR, 0);
 225
 226         usbhs_vbus_ctrl(priv, 0);
 227 }
 228
 229 /*
 230  *              device configuration
 231  */
 232 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
 233                            u16 upphub, u16 hubport, u16 speed)
 234 {
 235         struct device *dev = usbhs_priv_to_dev(priv);
 236         u16 usbspd = 0;
 237         u32 reg = DEVADD0 + (2 * devnum);
 238
 239         if (devnum > 10) {
 240                 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
 241                 return -EIO;
 242         }
 243
 244         if (upphub > 0xA) {
 245                 dev_err(dev, "unsupported hub number %d\n", upphub);
 246                 return -EIO;
 247         }
 248
 249         switch (speed) {
 250         case USB_SPEED_LOW:
 251                 usbspd = USBSPD_SPEED_LOW;
 252                 break;
 253         case USB_SPEED_FULL:
 254                 usbspd = USBSPD_SPEED_FULL;
 255                 break;
 256         case USB_SPEED_HIGH:
 257                 usbspd = USBSPD_SPEED_HIGH;
 258                 break;
 259         default:
 260                 dev_err(dev, "unsupported speed %d\n", speed);
 261                 return -EIO;
 262         }
 263
 264         usbhs_write(priv, reg,  UPPHUB(upphub)  |
 265                                 HUBPORT(hubport)|
 266                                 USBSPD(usbspd));
 267
 268         return 0;
 269 }
 270
 271 /*
 272  *              local functions
 273  */
 274 static void usbhsc_set_buswait(struct usbhs_priv *priv)
 275 {
 276         int wait = usbhs_get_dparam(priv, buswait_bwait);
 277
 278         /* set bus wait if platform have */
 279         if (wait)
 280                 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
 281 }
 282
 283 /*
 284  *              platform default param
 285  */
 286 static u32 usbhsc_default_pipe_type[] = {
 287                 USB_ENDPOINT_XFER_CONTROL,
 288                 USB_ENDPOINT_XFER_ISOC,
 289                 USB_ENDPOINT_XFER_ISOC,
 290                 USB_ENDPOINT_XFER_BULK,
 291                 USB_ENDPOINT_XFER_BULK,
 292                 USB_ENDPOINT_XFER_BULK,
 293                 USB_ENDPOINT_XFER_INT,
 294                 USB_ENDPOINT_XFER_INT,
 295                 USB_ENDPOINT_XFER_INT,
 296                 USB_ENDPOINT_XFER_INT,
 297 };
 298
 299 /*
 300  *              power control
 301  */
 302 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
 303 {
 304         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 305         struct device *dev = usbhs_priv_to_dev(priv);
 306
 307         if (enable) {
 308                 /* enable PM */
 309                 pm_runtime_get_sync(dev);
 310
 311                 /* enable platform power */
 312                 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
 313
 314                 /* USB on */
 315                 usbhs_sys_clock_ctrl(priv, enable);
 316         } else {
 317                 /* USB off */
 318                 usbhs_sys_clock_ctrl(priv, enable);
 319
 320                 /* disable platform power */
 321                 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
 322
 323                 /* disable PM */
 324                 pm_runtime_put_sync(dev);
 325         }
 326 }
 327
 328 /*
 329  *              hotplug
 330  */
 331 static void usbhsc_hotplug(struct usbhs_priv *priv)
 332 {
 333         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 334         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 335         int id;
 336         int enable;
 337         int ret;
 338
 339         /*
 340          * get vbus status from platform
 341          */
 342         enable = usbhs_platform_call(priv, get_vbus, pdev);
 343
 344         /*
 345          * get id from platform
 346          */
 347         id = usbhs_platform_call(priv, get_id, pdev);
 348
 349         if (enable && !mod) {
 350                 ret = usbhs_mod_change(priv, id);
 351                 if (ret < 0)
 352                         return;
 353
 354                 dev_dbg(&pdev->dev, "%s enable\n", __func__);
 355
 356                 /* power on */
 357                 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 358                         usbhsc_power_ctrl(priv, enable);
 359
 360                 /* bus init */
 361                 usbhsc_set_buswait(priv);
 362                 usbhsc_bus_init(priv);
 363
 364                 /* module start */
 365                 usbhs_mod_call(priv, start, priv);
 366
 367         } else if (!enable && mod) {
 368                 dev_dbg(&pdev->dev, "%s disable\n", __func__);
 369
 370                 /* module stop */
 371                 usbhs_mod_call(priv, stop, priv);
 372
 373                 /* bus init */
 374                 usbhsc_bus_init(priv);
 375
 376                 /* power off */
 377                 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 378                         usbhsc_power_ctrl(priv, enable);
 379
 380                 usbhs_mod_change(priv, -1);
 381
 382                 /* reset phy for next connection */
 383                 usbhs_platform_call(priv, phy_reset, pdev);
 384         }
 385 }
 386
 387 /*
 388  *              notify hotplug
 389  */
 390 static void usbhsc_notify_hotplug(struct work_struct *work)
 391 {
 392         struct usbhs_priv *priv = container_of(work,
 393                                                struct usbhs_priv,
 394                                                notify_hotplug_work.work);
 395         usbhsc_hotplug(priv);
 396 }
 397
 398 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
 399 {
 400         struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
 401         int delay = usbhs_get_dparam(priv, detection_delay);
 402
 403         /*
 404          * This functions will be called in interrupt.
 405          * To make sure safety context,
 406          * use workqueue for usbhs_notify_hotplug
 407          */
 408         schedule_delayed_work(&priv->notify_hotplug_work,
 409                               msecs_to_jiffies(delay));
 410         return 0;
 411 }
 412
 413 /*
 414  *              platform functions
 415  */
 416 static int usbhs_probe(struct platform_device *pdev)
 417 {
 418         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 419         struct renesas_usbhs_driver_callback *dfunc;
 420         struct usbhs_priv *priv;
 421         struct resource *res, *irq_res;
 422         int ret;
 423
 424         /* check platform information */
 425         if (!info ||
 426             !info->platform_callback.get_id) {
 427                 dev_err(&pdev->dev, "no platform information\n");
 428                 return -EINVAL;
 429         }
 430
 431         /* platform data */
 432         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 433         irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 434         if (!res || !irq_res) {
 435                 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
 436                 return -ENODEV;
 437         }
 438
 439         /* usb private data */
 440         priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
 441         if (!priv) {
 442                 dev_err(&pdev->dev, "Could not allocate priv\n");
 443                 return -ENOMEM;
 444         }
 445
 446         priv->base = devm_request_and_ioremap(&pdev->dev, res);
 447         if (!priv->base) {
 448                 dev_err(&pdev->dev, "ioremap error.\n");
 449                 return -ENOMEM;
 450         }
 451
 452         /*
 453          * care platform info
 454          */
 455         memcpy(&priv->pfunc,
 456                &info->platform_callback,
 457                sizeof(struct renesas_usbhs_platform_callback));
 458         memcpy(&priv->dparam,
 459                &info->driver_param,
 460                sizeof(struct renesas_usbhs_driver_param));
 461
 462         /* set driver callback functions for platform */
 463         dfunc                   = &info->driver_callback;
 464         dfunc->notify_hotplug   = usbhsc_drvcllbck_notify_hotplug;
 465
 466         /* set default param if platform doesn't have */
 467         if (!priv->dparam.pipe_type) {
 468                 priv->dparam.pipe_type = usbhsc_default_pipe_type;
 469                 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
 470         }
 471         if (!priv->dparam.pio_dma_border)
 472                 priv->dparam.pio_dma_border = 64; /* 64byte */
 473
 474         /* FIXME */
 475         /* runtime power control ? */
 476         if (priv->pfunc.get_vbus)
 477                 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
 478
 479         /*
 480          * priv settings
 481          */
 482         priv->irq       = irq_res->start;
 483         if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
 484                 priv->irqflags = IRQF_SHARED;
 485         priv->pdev      = pdev;
 486         INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
 487         spin_lock_init(usbhs_priv_to_lock(priv));
 488
 489         /* call pipe and module init */
 490         ret = usbhs_pipe_probe(priv);
 491         if (ret < 0)
 492                 return ret;
 493
 494         ret = usbhs_fifo_probe(priv);
 495         if (ret < 0)
 496                 goto probe_end_pipe_exit;
 497
 498         ret = usbhs_mod_probe(priv);
 499         if (ret < 0)
 500                 goto probe_end_fifo_exit;
 501
 502         /* dev_set_drvdata should be called after usbhs_mod_init */
 503         dev_set_drvdata(&pdev->dev, priv);
 504
 505         /*
 506          * deviece reset here because
 507          * USB device might be used in boot loader.
 508          */
 509         usbhs_sys_clock_ctrl(priv, 0);
 510
 511         /*
 512          * platform call
 513          *
 514          * USB phy setup might depend on CPU/Board.
 515          * If platform has its callback functions,
 516          * call it here.
 517          */
 518         ret = usbhs_platform_call(priv, hardware_init, pdev);
 519         if (ret < 0) {
 520                 dev_err(&pdev->dev, "platform prove failed.\n");
 521                 goto probe_end_mod_exit;
 522         }
 523
 524         /* reset phy for connection */
 525         usbhs_platform_call(priv, phy_reset, pdev);
 526
 527         /* power control */
 528         pm_runtime_enable(&pdev->dev);
 529         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
 530                 usbhsc_power_ctrl(priv, 1);
 531                 usbhs_mod_autonomy_mode(priv);
 532         }
 533
 534         /*
 535          * manual call notify_hotplug for cold plug
 536          */
 537         ret = usbhsc_drvcllbck_notify_hotplug(pdev);
 538         if (ret < 0)
 539                 goto probe_end_call_remove;
 540
 541         dev_info(&pdev->dev, "probed\n");
 542
 543         return ret;
 544
 545 probe_end_call_remove:
 546         usbhs_platform_call(priv, hardware_exit, pdev);
 547 probe_end_mod_exit:
 548         usbhs_mod_remove(priv);
 549 probe_end_fifo_exit:
 550         usbhs_fifo_remove(priv);
 551 probe_end_pipe_exit:
 552         usbhs_pipe_remove(priv);
 553
 554         dev_info(&pdev->dev, "probe failed\n");
 555
 556         return ret;
 557 }
 558
 559 static int usbhs_remove(struct platform_device *pdev)
 560 {
 561         struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
 562         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 563         struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
 564
 565         dev_dbg(&pdev->dev, "usb remove\n");
 566
 567         dfunc->notify_hotplug = NULL;
 568
 569         /* power off */
 570         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 571                 usbhsc_power_ctrl(priv, 0);
 572
 573         pm_runtime_disable(&pdev->dev);
 574
 575         usbhs_platform_call(priv, hardware_exit, pdev);
 576         usbhs_mod_remove(priv);
 577         usbhs_fifo_remove(priv);
 578         usbhs_pipe_remove(priv);
 579
 580         return 0;
 581 }
 582
 583 static int usbhsc_suspend(struct device *dev)
 584 {
 585         struct usbhs_priv *priv = dev_get_drvdata(dev);
 586         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 587
 588         if (mod) {
 589                 usbhs_mod_call(priv, stop, priv);
 590                 usbhs_mod_change(priv, -1);
 591         }
 592
 593         if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 594                 usbhsc_power_ctrl(priv, 0);
 595
 596         return 0;
 597 }
 598
 599 static int usbhsc_resume(struct device *dev)
 600 {
 601         struct usbhs_priv *priv = dev_get_drvdata(dev);
 602         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 603
 604         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 605                 usbhsc_power_ctrl(priv, 1);
 606
 607         usbhs_platform_call(priv, phy_reset, pdev);
 608
 609         usbhsc_drvcllbck_notify_hotplug(pdev);
 610
 611         return 0;
 612 }
 613
 614 static int usbhsc_runtime_nop(struct device *dev)
 615 {
 616         /* Runtime PM callback shared between ->runtime_suspend()
 617          * and ->runtime_resume(). Simply returns success.
 618          *
 619          * This driver re-initializes all registers after
 620          * pm_runtime_get_sync() anyway so there is no need
 621          * to save and restore registers here.
 622          */
 623         return 0;
 624 }
 625
 626 static const struct dev_pm_ops usbhsc_pm_ops = {
 627         .suspend                = usbhsc_suspend,
 628         .resume                 = usbhsc_resume,
 629         .runtime_suspend        = usbhsc_runtime_nop,
 630         .runtime_resume         = usbhsc_runtime_nop,
 631 };
 632
 633 static struct platform_driver renesas_usbhs_driver = {
 634         .driver         = {
 635                 .name   = "renesas_usbhs",
 636                 .pm     = &usbhsc_pm_ops,
 637         },
 638         .probe          = usbhs_probe,
 639         .remove         = usbhs_remove,
 640 };
 641
 642 module_platform_driver(renesas_usbhs_driver);
 643
 644 MODULE_LICENSE("GPL");
 645 MODULE_DESCRIPTION("Renesas USB driver");
 646 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");