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  * platform call back
  26  *
  27  * renesas usb support platform callback function.
  28  * Below macro call it.
  29  * if platform doesn't have callback, it return 0 (no error)
  30  */
  31 #define usbhs_platform_call(priv, func, args...)\
  32         (!(priv) ? -ENODEV :                    \
  33          !((priv)->pfunc->func) ? 0 :           \
  34          (priv)->pfunc->func(args))
  35
  36 /*
  37  *              common functions
  38  */
  39 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
  40 {
  41         return ioread16(priv->base + reg);
  42 }
  43
  44 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
  45 {
  46         iowrite16(data, priv->base + reg);
  47 }
  48
  49 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
  50 {
  51         u16 val = usbhs_read(priv, reg);
  52
  53         val &= ~mask;
  54         val |= data & mask;
  55
  56         usbhs_write(priv, reg, val);
  57 }
  58
  59 /*
  60  *              syscfg functions
  61  */
  62 void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
  63 {
  64         usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
  65 }
  66
  67 void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable)
  68 {
  69         usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
  70 }
  71
  72 void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
  73 {
  74         usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
  75 }
  76
  77 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
  78 {
  79         u16 mask = DCFM | DRPD | DPRPU;
  80         u16 val  = DCFM | DRPD;
  81
  82         /*
  83          * if enable
  84          *
  85          * - select Host mode
  86          * - D+ Line/D- Line Pull-down
  87          */
  88         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
  89 }
  90
  91 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
  92 {
  93         u16 mask = DCFM | DRPD | DPRPU;
  94         u16 val  = DPRPU;
  95
  96         /*
  97          * if enable
  98          *
  99          * - select Function mode
 100          * - D+ Line Pull-up
 101          */
 102         usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
 103 }
 104
 105 /*
 106  *              frame functions
 107  */
 108 int usbhs_frame_get_num(struct usbhs_priv *priv)
 109 {
 110         return usbhs_read(priv, FRMNUM) & FRNM_MASK;
 111 }
 112
 113 /*
 114  *              local functions
 115  */
 116 static struct usbhs_priv *usbhsc_pdev_to_priv(struct platform_device *pdev)
 117 {
 118         return dev_get_drvdata(&pdev->dev);
 119 }
 120
 121 static void usbhsc_bus_ctrl(struct usbhs_priv *priv, int enable)
 122 {
 123         int wait = usbhs_get_dparam(priv, buswait_bwait);
 124         u16 data = 0;
 125
 126         if (enable) {
 127                 /* set bus wait if platform have */
 128                 if (wait)
 129                         usbhs_bset(priv, BUSWAIT, 0x000F, wait);
 130         }
 131         usbhs_write(priv, DVSTCTR, data);
 132 }
 133
 134 /*
 135  *              platform default param
 136  */
 137 static u32 usbhsc_default_pipe_type[] = {
 138                 USB_ENDPOINT_XFER_CONTROL,
 139                 USB_ENDPOINT_XFER_ISOC,
 140                 USB_ENDPOINT_XFER_ISOC,
 141                 USB_ENDPOINT_XFER_BULK,
 142                 USB_ENDPOINT_XFER_BULK,
 143                 USB_ENDPOINT_XFER_BULK,
 144                 USB_ENDPOINT_XFER_INT,
 145                 USB_ENDPOINT_XFER_INT,
 146                 USB_ENDPOINT_XFER_INT,
 147                 USB_ENDPOINT_XFER_INT,
 148 };
 149
 150 /*
 151  *              driver callback functions
 152  */
 153 static void usbhsc_notify_hotplug(struct work_struct *work)
 154 {
 155         struct usbhs_priv *priv = container_of(work,
 156                                                struct usbhs_priv,
 157                                                notify_hotplug_work);
 158         struct platform_device *pdev = usbhs_priv_to_pdev(priv);
 159         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
 160         int id;
 161         int enable;
 162         int ret;
 163
 164         /*
 165          * get vbus status from platform
 166          */
 167         enable = usbhs_platform_call(priv, get_vbus, pdev);
 168
 169         /*
 170          * get id from platform
 171          */
 172         id = usbhs_platform_call(priv, get_id, pdev);
 173
 174         if (enable && !mod) {
 175                 ret = usbhs_mod_change(priv, id);
 176                 if (ret < 0)
 177                         return;
 178
 179                 dev_dbg(&pdev->dev, "%s enable\n", __func__);
 180
 181                 /* enable PM */
 182                 pm_runtime_get_sync(&pdev->dev);
 183
 184                 /* USB on */
 185                 usbhs_sys_clock_ctrl(priv, enable);
 186                 usbhsc_bus_ctrl(priv, enable);
 187
 188                 /* module start */
 189                 usbhs_mod_call(priv, start, priv);
 190
 191         } else if (!enable && mod) {
 192                 dev_dbg(&pdev->dev, "%s disable\n", __func__);
 193
 194                 /* module stop */
 195                 usbhs_mod_call(priv, stop, priv);
 196
 197                 /* USB off */
 198                 usbhsc_bus_ctrl(priv, enable);
 199                 usbhs_sys_clock_ctrl(priv, enable);
 200
 201                 /* disable PM */
 202                 pm_runtime_put_sync(&pdev->dev);
 203
 204                 usbhs_mod_change(priv, -1);
 205
 206                 /* reset phy for next connection */
 207                 usbhs_platform_call(priv, phy_reset, pdev);
 208         }
 209 }
 210
 211 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
 212 {
 213         struct usbhs_priv *priv = usbhsc_pdev_to_priv(pdev);
 214
 215         /*
 216          * This functions will be called in interrupt.
 217          * To make sure safety context,
 218          * use workqueue for usbhs_notify_hotplug
 219          */
 220         schedule_work(&priv->notify_hotplug_work);
 221         return 0;
 222 }
 223
 224 /*
 225  *              platform functions
 226  */
 227 static int __devinit usbhs_probe(struct platform_device *pdev)
 228 {
 229         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 230         struct renesas_usbhs_driver_callback *dfunc;
 231         struct usbhs_priv *priv;
 232         struct resource *res;
 233         unsigned int irq;
 234         int ret;
 235
 236         /* check platform information */
 237         if (!info ||
 238             !info->platform_callback.get_id ||
 239             !info->platform_callback.get_vbus) {
 240                 dev_err(&pdev->dev, "no platform information\n");
 241                 return -EINVAL;
 242         }
 243
 244         /* platform data */
 245         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 246         irq = platform_get_irq(pdev, 0);
 247         if (!res || (int)irq <= 0) {
 248                 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
 249                 return -ENODEV;
 250         }
 251
 252         /* usb private data */
 253         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 254         if (!priv) {
 255                 dev_err(&pdev->dev, "Could not allocate priv\n");
 256                 return -ENOMEM;
 257         }
 258
 259         priv->base = ioremap_nocache(res->start, resource_size(res));
 260         if (!priv->base) {
 261                 dev_err(&pdev->dev, "ioremap error.\n");
 262                 ret = -ENOMEM;
 263                 goto probe_end_kfree;
 264         }
 265
 266         /*
 267          * care platform info
 268          */
 269         priv->pfunc     = &info->platform_callback;
 270         priv->dparam    = &info->driver_param;
 271
 272         /* set driver callback functions for platform */
 273         dfunc                   = &info->driver_callback;
 274         dfunc->notify_hotplug   = usbhsc_drvcllbck_notify_hotplug;
 275
 276         /* set default param if platform doesn't have */
 277         if (!priv->dparam->pipe_type) {
 278                 priv->dparam->pipe_type = usbhsc_default_pipe_type;
 279                 priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
 280         }
 281
 282         /*
 283          * priv settings
 284          */
 285         priv->irq       = irq;
 286         priv->pdev      = pdev;
 287         INIT_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
 288         spin_lock_init(usbhs_priv_to_lock(priv));
 289
 290         /* call pipe and module init */
 291         ret = usbhs_pipe_probe(priv);
 292         if (ret < 0)
 293                 goto probe_end_mod_exit;
 294
 295         ret = usbhs_mod_probe(priv);
 296         if (ret < 0)
 297                 goto probe_end_iounmap;
 298
 299         /* dev_set_drvdata should be called after usbhs_mod_init */
 300         dev_set_drvdata(&pdev->dev, priv);
 301
 302         /*
 303          * deviece reset here because
 304          * USB device might be used in boot loader.
 305          */
 306         usbhs_sys_clock_ctrl(priv, 0);
 307
 308         /*
 309          * platform call
 310          *
 311          * USB phy setup might depend on CPU/Board.
 312          * If platform has its callback functions,
 313          * call it here.
 314          */
 315         ret = usbhs_platform_call(priv, hardware_init, pdev);
 316         if (ret < 0) {
 317                 dev_err(&pdev->dev, "platform prove failed.\n");
 318                 goto probe_end_pipe_exit;
 319         }
 320
 321         /* reset phy for connection */
 322         usbhs_platform_call(priv, phy_reset, pdev);
 323
 324         /*
 325          * manual call notify_hotplug for cold plug
 326          */
 327         pm_runtime_enable(&pdev->dev);
 328         ret = usbhsc_drvcllbck_notify_hotplug(pdev);
 329         if (ret < 0)
 330                 goto probe_end_call_remove;
 331
 332         dev_info(&pdev->dev, "probed\n");
 333
 334         return ret;
 335
 336 probe_end_call_remove:
 337         usbhs_platform_call(priv, hardware_exit, pdev);
 338 probe_end_pipe_exit:
 339         usbhs_pipe_remove(priv);
 340 probe_end_mod_exit:
 341         usbhs_mod_remove(priv);
 342 probe_end_iounmap:
 343         iounmap(priv->base);
 344 probe_end_kfree:
 345         kfree(priv);
 346
 347         dev_info(&pdev->dev, "probe failed\n");
 348
 349         return ret;
 350 }
 351
 352 static int __devexit usbhs_remove(struct platform_device *pdev)
 353 {
 354         struct usbhs_priv *priv = usbhsc_pdev_to_priv(pdev);
 355         struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
 356         struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
 357
 358         dev_dbg(&pdev->dev, "usb remove\n");
 359
 360         dfunc->notify_hotplug = NULL;
 361
 362         pm_runtime_disable(&pdev->dev);
 363
 364         usbhsc_bus_ctrl(priv, 0);
 365
 366         usbhs_platform_call(priv, hardware_exit, pdev);
 367         usbhs_pipe_remove(priv);
 368         usbhs_mod_remove(priv);
 369         iounmap(priv->base);
 370         kfree(priv);
 371
 372         return 0;
 373 }
 374
 375 static struct platform_driver renesas_usbhs_driver = {
 376         .driver         = {
 377                 .name   = "renesas_usbhs",
 378         },
 379         .probe          = usbhs_probe,
 380         .remove         = __devexit_p(usbhs_remove),
 381 };
 382
 383 static int __init usbhs_init(void)
 384 {
 385         return platform_driver_register(&renesas_usbhs_driver);
 386 }
 387
 388 static void __exit usbhs_exit(void)
 389 {
 390         platform_driver_unregister(&renesas_usbhs_driver);
 391 }
 392
 393 module_init(usbhs_init);
 394 module_exit(usbhs_exit);
 395
 396 MODULE_LICENSE("GPL");
 397 MODULE_DESCRIPTION("Renesas USB driver");
 398 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");