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 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_hispeed_ctrl(struct usbhs_priv *priv, int enable)
 104 {
 105         usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
 106 }
 107
 108 void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
 109 {
 110         usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
 111 }
 112
 113 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
 114 {
 115         u16 mask = DCFM | DRPD | DPRPU;
 116         u16 val  = DCFM | DRPD;
 117         int has_otg = usbhs_get_dparam(priv, has_otg);
 118
 119         if (has_otg)
 120                 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
 121
 122         /*
 123          * if enable
 124          *
 125          * - select Host mode
 126          * - D+ Line/D- Line Pull-down
 127          */
 128         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
 129 }
 130
 131 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
 132 {
 133         u16 mask = DCFM | DRPD | DPRPU;
 134         u16 val  = DPRPU;
 135
 136         /*
 137          * if enable
 138          *
 139          * - select Function mode
 140          * - D+ Line Pull-up
 141          */
 142         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
 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  *              local functions
 231  */
 232 static void usbhsc_set_buswait(struct usbhs_priv *priv)
 233 {
 234         int wait = usbhs_get_dparam(priv, buswait_bwait);
 235
 236         /* set bus wait if platform have */
 237         if (wait)
 238                 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
 239 }
 240
 241 /*
 242  *              platform default param
 243  */
 244 static u32 usbhsc_default_pipe_type[] = {
 245                 USB_ENDPOINT_XFER_CONTROL,
 246                 USB_ENDPOINT_XFER_ISOC,
 247                 USB_ENDPOINT_XFER_ISOC,
 248                 USB_ENDPOINT_XFER_BULK,
 249                 USB_ENDPOINT_XFER_BULK,
 250                 USB_ENDPOINT_XFER_BULK,
 251                 USB_ENDPOINT_XFER_INT,
 252                 USB_ENDPOINT_XFER_INT,
 253                 USB_ENDPOINT_XFER_INT,
 254                 USB_ENDPOINT_XFER_INT,
 255 };
 256
 257 /*
 258  *              power control
 259  */
 260 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
 261 {
 262         struct device *dev = usbhs_priv_to_dev(priv);
 263
 264         if (enable) {
 265                 /* enable PM */
 266                 pm_runtime_get_sync(dev);
 267
 268                 /* USB on */
 269                 usbhs_sys_clock_ctrl(priv, enable);
 270         } else {
 271                 /* USB off */
 272                 usbhs_sys_clock_ctrl(priv, enable);
 273
 274                 /* disable PM */
 275                 pm_runtime_put_sync(dev);
 276         }
 277 }
 278
 279 /*
 280  *              hotplug
 281  */
 282 static void usbhsc_hotplug(struct usbhs_priv *priv)
 283 {
 284         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 285         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 286         int id;
 287         int enable;
 288         int ret;
 289
 290         /*
 291          * get vbus status from platform
 292          */
 293         enable = usbhs_platform_call(priv, get_vbus, pdev);
 294
 295         /*
 296          * get id from platform
 297          */
 298         id = usbhs_platform_call(priv, get_id, pdev);
 299
 300         if (enable && !mod) {
 301                 ret = usbhs_mod_change(priv, id);
 302                 if (ret < 0)
 303                         return;
 304
 305                 dev_dbg(&pdev->dev, "%s enable\n", __func__);
 306
 307                 /* power on */
 308                 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 309                         usbhsc_power_ctrl(priv, enable);
 310
 311                 /* bus init */
 312                 usbhsc_set_buswait(priv);
 313                 usbhsc_bus_init(priv);
 314
 315                 /* module start */
 316                 usbhs_mod_call(priv, start, priv);
 317
 318         } else if (!enable && mod) {
 319                 dev_dbg(&pdev->dev, "%s disable\n", __func__);
 320
 321                 /* module stop */
 322                 usbhs_mod_call(priv, stop, priv);
 323
 324                 /* bus init */
 325                 usbhsc_bus_init(priv);
 326
 327                 /* power off */
 328                 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 329                         usbhsc_power_ctrl(priv, enable);
 330
 331                 usbhs_mod_change(priv, -1);
 332
 333                 /* reset phy for next connection */
 334                 usbhs_platform_call(priv, phy_reset, pdev);
 335         }
 336 }
 337
 338 /*
 339  *              notify hotplug
 340  */
 341 static void usbhsc_notify_hotplug(struct work_struct *work)
 342 {
 343         struct usbhs_priv *priv = container_of(work,
 344                                                struct usbhs_priv,
 345                                                notify_hotplug_work.work);
 346         usbhsc_hotplug(priv);
 347 }
 348
 349 int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
 350 {
 351         struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
 352         int delay = usbhs_get_dparam(priv, detection_delay);
 353
 354         /*
 355          * This functions will be called in interrupt.
 356          * To make sure safety context,
 357          * use workqueue for usbhs_notify_hotplug
 358          */
 359         schedule_delayed_work(&priv->notify_hotplug_work, delay);
 360         return 0;
 361 }
 362
 363 /*
 364  *              platform functions
 365  */
 366 static int __devinit usbhs_probe(struct platform_device *pdev)
 367 {
 368         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 369         struct renesas_usbhs_driver_callback *dfunc;
 370         struct usbhs_priv *priv;
 371         struct resource *res;
 372         unsigned int irq;
 373         int ret;
 374
 375         /* check platform information */
 376         if (!info ||
 377             !info->platform_callback.get_id) {
 378                 dev_err(&pdev->dev, "no platform information\n");
 379                 return -EINVAL;
 380         }
 381
 382         /* platform data */
 383         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 384         irq = platform_get_irq(pdev, 0);
 385         if (!res || (int)irq <= 0) {
 386                 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
 387                 return -ENODEV;
 388         }
 389
 390         /* usb private data */
 391         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 392         if (!priv) {
 393                 dev_err(&pdev->dev, "Could not allocate priv\n");
 394                 return -ENOMEM;
 395         }
 396
 397         priv->base = ioremap_nocache(res->start, resource_size(res));
 398         if (!priv->base) {
 399                 dev_err(&pdev->dev, "ioremap error.\n");
 400                 ret = -ENOMEM;
 401                 goto probe_end_kfree;
 402         }
 403
 404         /*
 405          * care platform info
 406          */
 407         priv->pfunc     = &info->platform_callback;
 408         priv->dparam    = &info->driver_param;
 409
 410         /* set driver callback functions for platform */
 411         dfunc                   = &info->driver_callback;
 412         dfunc->notify_hotplug   = usbhsc_drvcllbck_notify_hotplug;
 413
 414         /* set default param if platform doesn't have */
 415         if (!priv->dparam->pipe_type) {
 416                 priv->dparam->pipe_type = usbhsc_default_pipe_type;
 417                 priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
 418         }
 419         if (!priv->dparam->pio_dma_border)
 420                 priv->dparam->pio_dma_border = 64; /* 64byte */
 421
 422         /* FIXME */
 423         /* runtime power control ? */
 424         if (priv->pfunc->get_vbus)
 425                 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
 426
 427         /*
 428          * priv settings
 429          */
 430         priv->irq       = irq;
 431         priv->pdev      = pdev;
 432         INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
 433         spin_lock_init(usbhs_priv_to_lock(priv));
 434
 435         /* call pipe and module init */
 436         ret = usbhs_pipe_probe(priv);
 437         if (ret < 0)
 438                 goto probe_end_iounmap;
 439
 440         ret = usbhs_fifo_probe(priv);
 441         if (ret < 0)
 442                 goto probe_end_pipe_exit;
 443
 444         ret = usbhs_mod_probe(priv);
 445         if (ret < 0)
 446                 goto probe_end_fifo_exit;
 447
 448         /* dev_set_drvdata should be called after usbhs_mod_init */
 449         dev_set_drvdata(&pdev->dev, priv);
 450
 451         /*
 452          * deviece reset here because
 453          * USB device might be used in boot loader.
 454          */
 455         usbhs_sys_clock_ctrl(priv, 0);
 456
 457         /*
 458          * platform call
 459          *
 460          * USB phy setup might depend on CPU/Board.
 461          * If platform has its callback functions,
 462          * call it here.
 463          */
 464         ret = usbhs_platform_call(priv, hardware_init, pdev);
 465         if (ret < 0) {
 466                 dev_err(&pdev->dev, "platform prove failed.\n");
 467                 goto probe_end_mod_exit;
 468         }
 469
 470         /* reset phy for connection */
 471         usbhs_platform_call(priv, phy_reset, pdev);
 472
 473         /* power control */
 474         pm_runtime_enable(&pdev->dev);
 475         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
 476                 usbhsc_power_ctrl(priv, 1);
 477                 usbhs_mod_autonomy_mode(priv);
 478         }
 479
 480         /*
 481          * manual call notify_hotplug for cold plug
 482          */
 483         ret = usbhsc_drvcllbck_notify_hotplug(pdev);
 484         if (ret < 0)
 485                 goto probe_end_call_remove;
 486
 487         dev_info(&pdev->dev, "probed\n");
 488
 489         return ret;
 490
 491 probe_end_call_remove:
 492         usbhs_platform_call(priv, hardware_exit, pdev);
 493 probe_end_mod_exit:
 494         usbhs_mod_remove(priv);
 495 probe_end_fifo_exit:
 496         usbhs_fifo_remove(priv);
 497 probe_end_pipe_exit:
 498         usbhs_pipe_remove(priv);
 499 probe_end_iounmap:
 500         iounmap(priv->base);
 501 probe_end_kfree:
 502         kfree(priv);
 503
 504         dev_info(&pdev->dev, "probe failed\n");
 505
 506         return ret;
 507 }
 508
 509 static int __devexit usbhs_remove(struct platform_device *pdev)
 510 {
 511         struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
 512         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 513         struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
 514
 515         dev_dbg(&pdev->dev, "usb remove\n");
 516
 517         dfunc->notify_hotplug = NULL;
 518
 519         /* power off */
 520         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 521                 usbhsc_power_ctrl(priv, 0);
 522
 523         pm_runtime_disable(&pdev->dev);
 524
 525         usbhs_platform_call(priv, hardware_exit, pdev);
 526         usbhs_mod_remove(priv);
 527         usbhs_fifo_remove(priv);
 528         usbhs_pipe_remove(priv);
 529         iounmap(priv->base);
 530         kfree(priv);
 531
 532         return 0;
 533 }
 534
 535 static int usbhsc_suspend(struct device *dev)
 536 {
 537         struct usbhs_priv *priv = dev_get_drvdata(dev);
 538         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 539
 540         if (mod) {
 541                 usbhs_mod_call(priv, stop, priv);
 542                 usbhs_mod_change(priv, -1);
 543         }
 544
 545         if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 546                 usbhsc_power_ctrl(priv, 0);
 547
 548         return 0;
 549 }
 550
 551 static int usbhsc_resume(struct device *dev)
 552 {
 553         struct usbhs_priv *priv = dev_get_drvdata(dev);
 554         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 555
 556         usbhs_platform_call(priv, phy_reset, pdev);
 557
 558         if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
 559                 usbhsc_power_ctrl(priv, 1);
 560
 561         usbhsc_hotplug(priv);
 562
 563         return 0;
 564 }
 565
 566 static int usbhsc_runtime_nop(struct device *dev)
 567 {
 568         /* Runtime PM callback shared between ->runtime_suspend()
 569          * and ->runtime_resume(). Simply returns success.
 570          *
 571          * This driver re-initializes all registers after
 572          * pm_runtime_get_sync() anyway so there is no need
 573          * to save and restore registers here.
 574          */
 575         return 0;
 576 }
 577
 578 static const struct dev_pm_ops usbhsc_pm_ops = {
 579         .suspend                = usbhsc_suspend,
 580         .resume                 = usbhsc_resume,
 581         .runtime_suspend        = usbhsc_runtime_nop,
 582         .runtime_resume         = usbhsc_runtime_nop,
 583 };
 584
 585 static struct platform_driver renesas_usbhs_driver = {
 586         .driver         = {
 587                 .name   = "renesas_usbhs",
 588                 .pm     = &usbhsc_pm_ops,
 589         },
 590         .probe          = usbhs_probe,
 591         .remove         = __devexit_p(usbhs_remove),
 592 };
 593
 594 static int __init usbhs_init(void)
 595 {
 596         return platform_driver_register(&renesas_usbhs_driver);
 597 }
 598
 599 static void __exit usbhs_exit(void)
 600 {
 601         platform_driver_unregister(&renesas_usbhs_driver);
 602 }
 603
 604 module_init(usbhs_init);
 605 module_exit(usbhs_exit);
 606
 607 MODULE_LICENSE("GPL");
 608 MODULE_DESCRIPTION("Renesas USB driver");
 609 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");