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

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