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