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 pdev->dev.of_node = ofdev->dev.of_node; 116 pdev->dev.of_node_reused = true; 117 118 retval = platform_device_add(pdev); 119 if (retval) 120 goto error; 121 122 return pdev; 123 124 error: 125 platform_device_put(pdev); 126 return ERR_PTR(retval); 127 } 128 129 static const struct of_device_id fsl_usb2_mph_dr_of_match[]; 130 131 static enum fsl_usb2_controller_ver usb_get_ver_info(struct device_node *np) 132 { 133 enum fsl_usb2_controller_ver ver = FSL_USB_VER_NONE; 134 135 /* 136 * returns 1 for usb controller version 1.6 137 * returns 2 for usb controller version 2.2 138 * returns 3 for usb controller version 2.4 139 * returns 4 for usb controller version 2.5 140 * returns 0 otherwise 141 */ 142 if (of_device_is_compatible(np, "fsl-usb2-dr")) { 143 if (of_device_is_compatible(np, "fsl-usb2-dr-v1.6")) 144 ver = FSL_USB_VER_1_6; 145 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.2")) 146 ver = FSL_USB_VER_2_2; 147 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.4")) 148 ver = FSL_USB_VER_2_4; 149 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.5")) 150 ver = FSL_USB_VER_2_5; 151 else /* for previous controller versions */ 152 ver = FSL_USB_VER_OLD; 153 154 if (ver > FSL_USB_VER_NONE) 155 return ver; 156 } 157 158 if (of_device_is_compatible(np, "fsl,mpc5121-usb2-dr")) 159 return FSL_USB_VER_OLD; 160 161 if (of_device_is_compatible(np, "fsl-usb2-mph")) { 162 if (of_device_is_compatible(np, "fsl-usb2-mph-v1.6")) 163 ver = FSL_USB_VER_1_6; 164 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.2")) 165 ver = FSL_USB_VER_2_2; 166 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.4")) 167 ver = FSL_USB_VER_2_4; 168 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.5")) 169 ver = FSL_USB_VER_2_5; 170 else /* for previous controller versions */ 171 ver = FSL_USB_VER_OLD; 172 } 173 174 return ver; 175 } 176 177 static int fsl_usb2_mph_dr_of_probe(struct platform_device *ofdev) 178 { 179 struct device_node *np = ofdev->dev.of_node; 180 struct platform_device *usb_dev; 181 struct fsl_usb2_platform_data data, *pdata; 182 struct fsl_usb2_dev_data *dev_data; 183 const struct of_device_id *match; 184 const unsigned char *prop; 185 static unsigned int idx; 186 int i; 187 188 if (!of_device_is_available(np)) 189 return -ENODEV; 190 191 match = of_match_device(fsl_usb2_mph_dr_of_match, &ofdev->dev); 192 if (!match) 193 return -ENODEV; 194 195 pdata = &data; 196 if (match->data) 197 memcpy(pdata, match->data, sizeof(data)); 198 else 199 memset(pdata, 0, sizeof(data)); 200 201 dev_data = get_dr_mode_data(np); 202 203 if (of_device_is_compatible(np, "fsl-usb2-mph")) { 204 if (of_get_property(np, "port0", NULL)) 205 pdata->port_enables |= FSL_USB2_PORT0_ENABLED; 206 207 if (of_get_property(np, "port1", NULL)) 208 pdata->port_enables |= FSL_USB2_PORT1_ENABLED; 209 210 pdata->operating_mode = FSL_USB2_MPH_HOST; 211 } else { 212 if (of_get_property(np, "fsl,invert-drvvbus", NULL)) 213 pdata->invert_drvvbus = 1; 214 215 if (of_get_property(np, "fsl,invert-pwr-fault", NULL)) 216 pdata->invert_pwr_fault = 1; 217 218 /* setup mode selected in the device tree */ 219 pdata->operating_mode = dev_data->op_mode; 220 } 221 222 prop = of_get_property(np, "phy_type", NULL); 223 pdata->phy_mode = determine_usb_phy(prop); 224 pdata->controller_ver = usb_get_ver_info(np); 225 226 /* Activate Erratum by reading property in device tree */ 227 pdata->has_fsl_erratum_a007792 = 228 of_property_read_bool(np, "fsl,usb-erratum-a007792"); 229 pdata->has_fsl_erratum_a005275 = 230 of_property_read_bool(np, "fsl,usb-erratum-a005275"); 231 pdata->has_fsl_erratum_a005697 = 232 of_property_read_bool(np, "fsl,usb_erratum-a005697"); 233 pdata->has_fsl_erratum_a006918 = 234 of_property_read_bool(np, "fsl,usb_erratum-a006918"); 235 pdata->has_fsl_erratum_14 = 236 of_property_read_bool(np, "fsl,usb_erratum-14"); 237 238 /* 239 * Determine whether phy_clk_valid needs to be checked 240 * by reading property in device tree 241 */ 242 pdata->check_phy_clk_valid = 243 of_property_read_bool(np, "phy-clk-valid"); 244 245 if (pdata->have_sysif_regs) { 246 if (pdata->controller_ver == FSL_USB_VER_NONE) { 247 dev_warn(&ofdev->dev, "Could not get controller version\n"); 248 return -ENODEV; 249 } 250 } 251 252 for (i = 0; i < ARRAY_SIZE(dev_data->drivers); i++) { 253 if (!dev_data->drivers[i]) 254 continue; 255 usb_dev = fsl_usb2_device_register(ofdev, pdata, 256 dev_data->drivers[i], idx); 257 if (IS_ERR(usb_dev)) { 258 dev_err(&ofdev->dev, "Can't register usb device\n"); 259 return PTR_ERR(usb_dev); 260 } 261 } 262 idx++; 263 return 0; 264 } 265 266 static int __unregister_subdev(struct device *dev, void *d) 267 { 268 platform_device_unregister(to_platform_device(dev)); 269 return 0; 270 } 271 272 static int fsl_usb2_mph_dr_of_remove(struct platform_device *ofdev) 273 { 274 device_for_each_child(&ofdev->dev, NULL, __unregister_subdev); 275 return 0; 276 } 277 278 #ifdef CONFIG_PPC_MPC512x 279 280 #define USBGENCTRL 0x200 /* NOTE: big endian */ 281 #define GC_WU_INT_CLR (1 << 5) /* Wakeup int clear */ 282 #define GC_ULPI_SEL (1 << 4) /* ULPI i/f select (usb0 only)*/ 283 #define GC_PPP (1 << 3) /* Inv. Port Power Polarity */ 284 #define GC_PFP (1 << 2) /* Inv. Power Fault Polarity */ 285 #define GC_WU_ULPI_EN (1 << 1) /* Wakeup on ULPI event */ 286 #define GC_WU_IE (1 << 1) /* Wakeup interrupt enable */ 287 288 #define ISIPHYCTRL 0x204 /* NOTE: big endian */ 289 #define PHYCTRL_PHYE (1 << 4) /* On-chip UTMI PHY enable */ 290 #define PHYCTRL_BSENH (1 << 3) /* Bit Stuff Enable High */ 291 #define PHYCTRL_BSEN (1 << 2) /* Bit Stuff Enable */ 292 #define PHYCTRL_LSFE (1 << 1) /* Line State Filter Enable */ 293 #define PHYCTRL_PXE (1 << 0) /* PHY oscillator enable */ 294 295 int fsl_usb2_mpc5121_init(struct platform_device *pdev) 296 { 297 struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev); 298 struct clk *clk; 299 int err; 300 301 clk = devm_clk_get(pdev->dev.parent, "ipg"); 302 if (IS_ERR(clk)) { 303 dev_err(&pdev->dev, "failed to get clk\n"); 304 return PTR_ERR(clk); 305 } 306 err = clk_prepare_enable(clk); 307 if (err) { 308 dev_err(&pdev->dev, "failed to enable clk\n"); 309 return err; 310 } 311 pdata->clk = clk; 312 313 if (pdata->phy_mode == FSL_USB2_PHY_UTMI_WIDE) { 314 u32 reg = 0; 315 316 if (pdata->invert_drvvbus) 317 reg |= GC_PPP; 318 319 if (pdata->invert_pwr_fault) 320 reg |= GC_PFP; 321 322 out_be32(pdata->regs + ISIPHYCTRL, PHYCTRL_PHYE | PHYCTRL_PXE); 323 out_be32(pdata->regs + USBGENCTRL, reg); 324 } 325 return 0; 326 } 327 328 static void fsl_usb2_mpc5121_exit(struct platform_device *pdev) 329 { 330 struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev); 331 332 pdata->regs = NULL; 333 334 if (pdata->clk) 335 clk_disable_unprepare(pdata->clk); 336 } 337 338 static struct fsl_usb2_platform_data fsl_usb2_mpc5121_pd = { 339 .big_endian_desc = 1, 340 .big_endian_mmio = 1, 341 .es = 1, 342 .have_sysif_regs = 0, 343 .le_setup_buf = 1, 344 .init = fsl_usb2_mpc5121_init, 345 .exit = fsl_usb2_mpc5121_exit, 346 }; 347 #endif /* CONFIG_PPC_MPC512x */ 348 349 static struct fsl_usb2_platform_data fsl_usb2_mpc8xxx_pd = { 350 .have_sysif_regs = 1, 351 }; 352 353 static const struct of_device_id fsl_usb2_mph_dr_of_match[] = { 354 { .compatible = "fsl-usb2-mph", .data = &fsl_usb2_mpc8xxx_pd, }, 355 { .compatible = "fsl-usb2-dr", .data = &fsl_usb2_mpc8xxx_pd, }, 356 #ifdef CONFIG_PPC_MPC512x 357 { .compatible = "fsl,mpc5121-usb2-dr", .data = &fsl_usb2_mpc5121_pd, }, 358 #endif 359 {}, 360 }; 361 MODULE_DEVICE_TABLE(of, fsl_usb2_mph_dr_of_match); 362 363 static struct platform_driver fsl_usb2_mph_dr_driver = { 364 .driver = { 365 .name = "fsl-usb2-mph-dr", 366 .of_match_table = fsl_usb2_mph_dr_of_match, 367 }, 368 .probe = fsl_usb2_mph_dr_of_probe, 369 .remove = fsl_usb2_mph_dr_of_remove, 370 }; 371 372 module_platform_driver(fsl_usb2_mph_dr_driver); 373 374 MODULE_DESCRIPTION("FSL MPH DR OF devices driver"); 375 MODULE_AUTHOR("Anatolij Gustschin <agust@denx.de>"); 376 MODULE_LICENSE("GPL"); 377