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