drivers/usb/host/fsl-mph-dr-of.c

   1 /*
   2  * Setup platform devices needed by the Freescale multi-port host
   3  * and/or dual-role USB controller modules based on the description
   4  * in flat device tree.
   5  *
   6  * This program is free software; you can redistribute  it and/or modify it
   7  * under  the terms of  the GNU General  Public License as published by the
   8  * Free Software Foundation;  either version 2 of the  License, or (at your
   9  * option) any later version.
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/fsl_devices.h>
  15 #include <linux/err.h>
  16 #include <linux/io.h>
  17 #include <linux/of_platform.h>
  18 #include <linux/clk.h>
  19 #include <linux/module.h>
  20
  21 struct fsl_usb2_dev_data {
  22         char *dr_mode;          /* controller mode */
  23         char *drivers[3];       /* drivers to instantiate for this mode */
  24         enum fsl_usb2_operating_modes op_mode;  /* operating mode */
  25 };
  26
  27 static struct fsl_usb2_dev_data dr_mode_data[] = {
  28         {
  29                 .dr_mode = "host",
  30                 .drivers = { "fsl-ehci", NULL, NULL, },
  31                 .op_mode = FSL_USB2_DR_HOST,
  32         },
  33         {
  34                 .dr_mode = "otg",
  35                 .drivers = { "fsl-usb2-otg", "fsl-ehci", "fsl-usb2-udc", },
  36                 .op_mode = FSL_USB2_DR_OTG,
  37         },
  38         {
  39                 .dr_mode = "peripheral",
  40                 .drivers = { "fsl-usb2-udc", NULL, NULL, },
  41                 .op_mode = FSL_USB2_DR_DEVICE,
  42         },
  43 };
  44
  45 static struct fsl_usb2_dev_data *get_dr_mode_data(struct device_node *np)
  46 {
  47         const unsigned char *prop;
  48         int i;
  49
  50         prop = of_get_property(np, "dr_mode", NULL);
  51         if (prop) {
  52                 for (i = 0; i < ARRAY_SIZE(dr_mode_data); i++) {
  53                         if (!strcmp(prop, dr_mode_data[i].dr_mode))
  54                                 return &dr_mode_data[i];
  55                 }
  56         }
  57         pr_warn("%s: Invalid 'dr_mode' property, fallback to host mode\n",
  58                 np->full_name);
  59         return &dr_mode_data[0]; /* mode not specified, use host */
  60 }
  61
  62 static enum fsl_usb2_phy_modes determine_usb_phy(const char *phy_type)
  63 {
  64         if (!phy_type)
  65                 return FSL_USB2_PHY_NONE;
  66         if (!strcasecmp(phy_type, "ulpi"))
  67                 return FSL_USB2_PHY_ULPI;
  68         if (!strcasecmp(phy_type, "utmi"))
  69                 return FSL_USB2_PHY_UTMI;
  70         if (!strcasecmp(phy_type, "utmi_wide"))
  71                 return FSL_USB2_PHY_UTMI_WIDE;
  72         if (!strcasecmp(phy_type, "serial"))
  73                 return FSL_USB2_PHY_SERIAL;
  74
  75         return FSL_USB2_PHY_NONE;
  76 }
  77
  78 static struct platform_device *fsl_usb2_device_register(
  79                                         struct platform_device *ofdev,
  80                                         struct fsl_usb2_platform_data *pdata,
  81                                         const char *name, int id)
  82 {
  83         struct platform_device *pdev;
  84         const struct resource *res = ofdev->resource;
  85         unsigned int num = ofdev->num_resources;
  86         int retval;
  87
  88         pdev = platform_device_alloc(name, id);
  89         if (!pdev) {
  90                 retval = -ENOMEM;
  91                 goto error;
  92         }
  93
  94         pdev->dev.parent = &ofdev->dev;
  95
  96         pdev->dev.coherent_dma_mask = ofdev->dev.coherent_dma_mask;
  97         *pdev->dev.dma_mask = *ofdev->dev.dma_mask;
  98
  99         retval = platform_device_add_data(pdev, pdata, sizeof(*pdata));
 100         if (retval)
 101                 goto error;
 102
 103         if (num) {
 104                 retval = platform_device_add_resources(pdev, res, num);
 105                 if (retval)
 106                         goto error;
 107         }
 108
 109         retval = platform_device_add(pdev);
 110         if (retval)
 111                 goto error;
 112
 113         return pdev;
 114
 115 error:
 116         platform_device_put(pdev);
 117         return ERR_PTR(retval);
 118 }
 119
 120 static const struct of_device_id fsl_usb2_mph_dr_of_match[];
 121
 122 static int usb_get_ver_info(struct device_node *np)
 123 {
 124         int ver = -1;
 125
 126         /*
 127          * returns 1 for usb controller version 1.6
 128          * returns 2 for usb controller version 2.2
 129          * returns 3 for usb controller version 2.4
 130          * returns 4 for usb controller version 2.5
 131          * returns 0 otherwise
 132          */
 133         if (of_device_is_compatible(np, "fsl-usb2-dr")) {
 134                 if (of_device_is_compatible(np, "fsl-usb2-dr-v1.6"))
 135                         ver = FSL_USB_VER_1_6;
 136                 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.2"))
 137                         ver = FSL_USB_VER_2_2;
 138                 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.4"))
 139                         ver = FSL_USB_VER_2_4;
 140                 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.5"))
 141                         ver = FSL_USB_VER_2_5;
 142                 else /* for previous controller versions */
 143                         ver = FSL_USB_VER_OLD;
 144
 145                 if (ver > -1)
 146                         return ver;
 147         }
 148
 149         if (of_device_is_compatible(np, "fsl,mpc5121-usb2-dr"))
 150                 return FSL_USB_VER_OLD;
 151
 152         if (of_device_is_compatible(np, "fsl-usb2-mph")) {
 153                 if (of_device_is_compatible(np, "fsl-usb2-mph-v1.6"))
 154                         ver = FSL_USB_VER_1_6;
 155                 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.2"))
 156                         ver = FSL_USB_VER_2_2;
 157                 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.4"))
 158                         ver = FSL_USB_VER_2_4;
 159                 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.5"))
 160                         ver = FSL_USB_VER_2_5;
 161                 else /* for previous controller versions */
 162                         ver = FSL_USB_VER_OLD;
 163         }
 164
 165         return ver;
 166 }
 167
 168 static int fsl_usb2_mph_dr_of_probe(struct platform_device *ofdev)
 169 {
 170         struct device_node *np = ofdev->dev.of_node;
 171         struct platform_device *usb_dev;
 172         struct fsl_usb2_platform_data data, *pdata;
 173         struct fsl_usb2_dev_data *dev_data;
 174         const struct of_device_id *match;
 175         const unsigned char *prop;
 176         static unsigned int idx;
 177         int i;
 178
 179         if (!of_device_is_available(np))
 180                 return -ENODEV;
 181
 182         match = of_match_device(fsl_usb2_mph_dr_of_match, &ofdev->dev);
 183         if (!match)
 184                 return -ENODEV;
 185
 186         pdata = &data;
 187         if (match->data)
 188                 memcpy(pdata, match->data, sizeof(data));
 189         else
 190                 memset(pdata, 0, sizeof(data));
 191
 192         dev_data = get_dr_mode_data(np);
 193
 194         if (of_device_is_compatible(np, "fsl-usb2-mph")) {
 195                 if (of_get_property(np, "port0", NULL))
 196                         pdata->port_enables |= FSL_USB2_PORT0_ENABLED;
 197
 198                 if (of_get_property(np, "port1", NULL))
 199                         pdata->port_enables |= FSL_USB2_PORT1_ENABLED;
 200
 201                 pdata->operating_mode = FSL_USB2_MPH_HOST;
 202         } else {
 203                 if (of_get_property(np, "fsl,invert-drvvbus", NULL))
 204                         pdata->invert_drvvbus = 1;
 205
 206                 if (of_get_property(np, "fsl,invert-pwr-fault", NULL))
 207                         pdata->invert_pwr_fault = 1;
 208
 209                 /* setup mode selected in the device tree */
 210                 pdata->operating_mode = dev_data->op_mode;
 211         }
 212
 213         prop = of_get_property(np, "phy_type", NULL);
 214         pdata->phy_mode = determine_usb_phy(prop);
 215         pdata->controller_ver = usb_get_ver_info(np);
 216
 217         if (pdata->have_sysif_regs) {
 218                 if (pdata->controller_ver < 0) {
 219                         dev_warn(&ofdev->dev, "Could not get controller version\n");
 220                         return -ENODEV;
 221                 }
 222         }
 223
 224         for (i = 0; i < ARRAY_SIZE(dev_data->drivers); i++) {
 225                 if (!dev_data->drivers[i])
 226                         continue;
 227                 usb_dev = fsl_usb2_device_register(ofdev, pdata,
 228                                         dev_data->drivers[i], idx);
 229                 if (IS_ERR(usb_dev)) {
 230                         dev_err(&ofdev->dev, "Can't register usb device\n");
 231                         return PTR_ERR(usb_dev);
 232                 }
 233         }
 234         idx++;
 235         return 0;
 236 }
 237
 238 static int __unregister_subdev(struct device *dev, void *d)
 239 {
 240         platform_device_unregister(to_platform_device(dev));
 241         return 0;
 242 }
 243
 244 static int fsl_usb2_mph_dr_of_remove(struct platform_device *ofdev)
 245 {
 246         device_for_each_child(&ofdev->dev, NULL, __unregister_subdev);
 247         return 0;
 248 }
 249
 250 #ifdef CONFIG_PPC_MPC512x
 251
 252 #define USBGENCTRL              0x200           /* NOTE: big endian */
 253 #define GC_WU_INT_CLR           (1 << 5)        /* Wakeup int clear */
 254 #define GC_ULPI_SEL             (1 << 4)        /* ULPI i/f select (usb0 only)*/
 255 #define GC_PPP                  (1 << 3)        /* Inv. Port Power Polarity */
 256 #define GC_PFP                  (1 << 2)        /* Inv. Power Fault Polarity */
 257 #define GC_WU_ULPI_EN           (1 << 1)        /* Wakeup on ULPI event */
 258 #define GC_WU_IE                (1 << 1)        /* Wakeup interrupt enable */
 259
 260 #define ISIPHYCTRL              0x204           /* NOTE: big endian */
 261 #define PHYCTRL_PHYE            (1 << 4)        /* On-chip UTMI PHY enable */
 262 #define PHYCTRL_BSENH           (1 << 3)        /* Bit Stuff Enable High */
 263 #define PHYCTRL_BSEN            (1 << 2)        /* Bit Stuff Enable */
 264 #define PHYCTRL_LSFE            (1 << 1)        /* Line State Filter Enable */
 265 #define PHYCTRL_PXE             (1 << 0)        /* PHY oscillator enable */
 266
 267 int fsl_usb2_mpc5121_init(struct platform_device *pdev)
 268 {
 269         struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev);
 270         struct clk *clk;
 271         int err;
 272
 273         clk = devm_clk_get(pdev->dev.parent, "ipg");
 274         if (IS_ERR(clk)) {
 275                 dev_err(&pdev->dev, "failed to get clk\n");
 276                 return PTR_ERR(clk);
 277         }
 278         err = clk_prepare_enable(clk);
 279         if (err) {
 280                 dev_err(&pdev->dev, "failed to enable clk\n");
 281                 return err;
 282         }
 283         pdata->clk = clk;
 284
 285         if (pdata->phy_mode == FSL_USB2_PHY_UTMI_WIDE) {
 286                 u32 reg = 0;
 287
 288                 if (pdata->invert_drvvbus)
 289                         reg |= GC_PPP;
 290
 291                 if (pdata->invert_pwr_fault)
 292                         reg |= GC_PFP;
 293
 294                 out_be32(pdata->regs + ISIPHYCTRL, PHYCTRL_PHYE | PHYCTRL_PXE);
 295                 out_be32(pdata->regs + USBGENCTRL, reg);
 296         }
 297         return 0;
 298 }
 299
 300 static void fsl_usb2_mpc5121_exit(struct platform_device *pdev)
 301 {
 302         struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev);
 303
 304         pdata->regs = NULL;
 305
 306         if (pdata->clk)
 307                 clk_disable_unprepare(pdata->clk);
 308 }
 309
 310 static struct fsl_usb2_platform_data fsl_usb2_mpc5121_pd = {
 311         .big_endian_desc = 1,
 312         .big_endian_mmio = 1,
 313         .es = 1,
 314         .have_sysif_regs = 0,
 315         .le_setup_buf = 1,
 316         .init = fsl_usb2_mpc5121_init,
 317         .exit = fsl_usb2_mpc5121_exit,
 318 };
 319 #endif /* CONFIG_PPC_MPC512x */
 320
 321 static struct fsl_usb2_platform_data fsl_usb2_mpc8xxx_pd = {
 322         .have_sysif_regs = 1,
 323 };
 324
 325 static const struct of_device_id fsl_usb2_mph_dr_of_match[] = {
 326         { .compatible = "fsl-usb2-mph", .data = &fsl_usb2_mpc8xxx_pd, },
 327         { .compatible = "fsl-usb2-dr", .data = &fsl_usb2_mpc8xxx_pd, },
 328 #ifdef CONFIG_PPC_MPC512x
 329         { .compatible = "fsl,mpc5121-usb2-dr", .data = &fsl_usb2_mpc5121_pd, },
 330 #endif
 331         {},
 332 };
 333
 334 static struct platform_driver fsl_usb2_mph_dr_driver = {
 335         .driver = {
 336                 .name = "fsl-usb2-mph-dr",
 337                 .of_match_table = fsl_usb2_mph_dr_of_match,
 338         },
 339         .probe  = fsl_usb2_mph_dr_of_probe,
 340         .remove = fsl_usb2_mph_dr_of_remove,
 341 };
 342
 343 module_platform_driver(fsl_usb2_mph_dr_driver);
 344
 345 MODULE_DESCRIPTION("FSL MPH DR OF devices driver");
 346 MODULE_AUTHOR("Anatolij Gustschin <agust@denx.de>");
 347 MODULE_LICENSE("GPL");