1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Generic platform ehci driver 4 * 5 * Copyright 2007 Steven Brown <sbrown@cortland.com> 6 * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de> 7 * Copyright 2014 Hans de Goede <hdegoede@redhat.com> 8 * 9 * Derived from the ohci-ssb driver 10 * Copyright 2007 Michael Buesch <m@bues.ch> 11 * 12 * Derived from the EHCI-PCI driver 13 * Copyright (c) 2000-2004 by David Brownell 14 * 15 * Derived from the ohci-pci driver 16 * Copyright 1999 Roman Weissgaerber 17 * Copyright 2000-2002 David Brownell 18 * Copyright 1999 Linus Torvalds 19 * Copyright 1999 Gregory P. Smith 20 * 21 * Licensed under the GNU/GPL. See COPYING for details. 22 */ 23 #include <linux/acpi.h> 24 #include <linux/clk.h> 25 #include <linux/dma-mapping.h> 26 #include <linux/err.h> 27 #include <linux/kernel.h> 28 #include <linux/hrtimer.h> 29 #include <linux/io.h> 30 #include <linux/module.h> 31 #include <linux/of.h> 32 #include <linux/phy/phy.h> 33 #include <linux/platform_device.h> 34 #include <linux/reset.h> 35 #include <linux/usb.h> 36 #include <linux/usb/hcd.h> 37 #include <linux/usb/ehci_pdriver.h> 38 #include <linux/usb/of.h> 39 40 #include "ehci.h" 41 42 #define DRIVER_DESC "EHCI generic platform driver" 43 #define EHCI_MAX_CLKS 4 44 #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv) 45 46 struct ehci_platform_priv { 47 struct clk *clks[EHCI_MAX_CLKS]; 48 struct reset_control *rsts; 49 struct phy **phys; 50 int num_phys; 51 bool reset_on_resume; 52 }; 53 54 static const char hcd_name[] = "ehci-platform"; 55 56 static int ehci_platform_reset(struct usb_hcd *hcd) 57 { 58 struct platform_device *pdev = to_platform_device(hcd->self.controller); 59 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev); 60 struct ehci_hcd *ehci = hcd_to_ehci(hcd); 61 int retval; 62 63 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug; 64 65 if (pdata->pre_setup) { 66 retval = pdata->pre_setup(hcd); 67 if (retval < 0) 68 return retval; 69 } 70 71 ehci->caps = hcd->regs + pdata->caps_offset; 72 retval = ehci_setup(hcd); 73 if (retval) 74 return retval; 75 76 if (pdata->no_io_watchdog) 77 ehci->need_io_watchdog = 0; 78 return 0; 79 } 80 81 static int ehci_platform_power_on(struct platform_device *dev) 82 { 83 struct usb_hcd *hcd = platform_get_drvdata(dev); 84 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd); 85 int clk, ret, phy_num; 86 87 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) { 88 ret = clk_prepare_enable(priv->clks[clk]); 89 if (ret) 90 goto err_disable_clks; 91 } 92 93 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) { 94 ret = phy_init(priv->phys[phy_num]); 95 if (ret) 96 goto err_exit_phy; 97 ret = phy_power_on(priv->phys[phy_num]); 98 if (ret) { 99 phy_exit(priv->phys[phy_num]); 100 goto err_exit_phy; 101 } 102 } 103 104 return 0; 105 106 err_exit_phy: 107 while (--phy_num >= 0) { 108 phy_power_off(priv->phys[phy_num]); 109 phy_exit(priv->phys[phy_num]); 110 } 111 err_disable_clks: 112 while (--clk >= 0) 113 clk_disable_unprepare(priv->clks[clk]); 114 115 return ret; 116 } 117 118 static void ehci_platform_power_off(struct platform_device *dev) 119 { 120 struct usb_hcd *hcd = platform_get_drvdata(dev); 121 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd); 122 int clk, phy_num; 123 124 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) { 125 phy_power_off(priv->phys[phy_num]); 126 phy_exit(priv->phys[phy_num]); 127 } 128 129 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--) 130 if (priv->clks[clk]) 131 clk_disable_unprepare(priv->clks[clk]); 132 } 133 134 static struct hc_driver __read_mostly ehci_platform_hc_driver; 135 136 static const struct ehci_driver_overrides platform_overrides __initconst = { 137 .reset = ehci_platform_reset, 138 .extra_priv_size = sizeof(struct ehci_platform_priv), 139 }; 140 141 static struct usb_ehci_pdata ehci_platform_defaults = { 142 .power_on = ehci_platform_power_on, 143 .power_suspend = ehci_platform_power_off, 144 .power_off = ehci_platform_power_off, 145 }; 146 147 static int ehci_platform_probe(struct platform_device *dev) 148 { 149 struct usb_hcd *hcd; 150 struct resource *res_mem; 151 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev); 152 struct ehci_platform_priv *priv; 153 struct ehci_hcd *ehci; 154 int err, irq, phy_num, clk = 0; 155 156 if (usb_disabled()) 157 return -ENODEV; 158 159 /* 160 * Use reasonable defaults so platforms don't have to provide these 161 * with DT probing on ARM. 162 */ 163 if (!pdata) 164 pdata = &ehci_platform_defaults; 165 166 err = dma_coerce_mask_and_coherent(&dev->dev, 167 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32)); 168 if (err) { 169 dev_err(&dev->dev, "Error: DMA mask configuration failed\n"); 170 return err; 171 } 172 173 irq = platform_get_irq(dev, 0); 174 if (irq < 0) { 175 dev_err(&dev->dev, "no irq provided"); 176 return irq; 177 } 178 179 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev, 180 dev_name(&dev->dev)); 181 if (!hcd) 182 return -ENOMEM; 183 184 platform_set_drvdata(dev, hcd); 185 dev->dev.platform_data = pdata; 186 priv = hcd_to_ehci_priv(hcd); 187 ehci = hcd_to_ehci(hcd); 188 189 if (pdata == &ehci_platform_defaults && dev->dev.of_node) { 190 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs")) 191 ehci->big_endian_mmio = 1; 192 193 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc")) 194 ehci->big_endian_desc = 1; 195 196 if (of_property_read_bool(dev->dev.of_node, "big-endian")) 197 ehci->big_endian_mmio = ehci->big_endian_desc = 1; 198 199 if (of_property_read_bool(dev->dev.of_node, 200 "needs-reset-on-resume")) 201 priv->reset_on_resume = true; 202 203 if (of_property_read_bool(dev->dev.of_node, 204 "has-transaction-translator")) 205 hcd->has_tt = 1; 206 207 priv->num_phys = of_count_phandle_with_args(dev->dev.of_node, 208 "phys", "#phy-cells"); 209 210 if (priv->num_phys > 0) { 211 priv->phys = devm_kcalloc(&dev->dev, priv->num_phys, 212 sizeof(struct phy *), GFP_KERNEL); 213 if (!priv->phys) 214 return -ENOMEM; 215 } else 216 priv->num_phys = 0; 217 218 for (phy_num = 0; phy_num < priv->num_phys; phy_num++) { 219 priv->phys[phy_num] = devm_of_phy_get_by_index( 220 &dev->dev, dev->dev.of_node, phy_num); 221 if (IS_ERR(priv->phys[phy_num])) { 222 err = PTR_ERR(priv->phys[phy_num]); 223 goto err_put_hcd; 224 } else if (!hcd->phy) { 225 /* Avoiding phy_get() in usb_add_hcd() */ 226 hcd->phy = priv->phys[phy_num]; 227 } 228 } 229 230 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) { 231 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk); 232 if (IS_ERR(priv->clks[clk])) { 233 err = PTR_ERR(priv->clks[clk]); 234 if (err == -EPROBE_DEFER) 235 goto err_put_clks; 236 priv->clks[clk] = NULL; 237 break; 238 } 239 } 240 } 241 242 priv->rsts = devm_reset_control_array_get_optional_shared(&dev->dev); 243 if (IS_ERR(priv->rsts)) { 244 err = PTR_ERR(priv->rsts); 245 goto err_put_clks; 246 } 247 248 err = reset_control_deassert(priv->rsts); 249 if (err) 250 goto err_put_clks; 251 252 if (pdata->big_endian_desc) 253 ehci->big_endian_desc = 1; 254 if (pdata->big_endian_mmio) 255 ehci->big_endian_mmio = 1; 256 if (pdata->has_tt) 257 hcd->has_tt = 1; 258 if (pdata->reset_on_resume) 259 priv->reset_on_resume = true; 260 261 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO 262 if (ehci->big_endian_mmio) { 263 dev_err(&dev->dev, 264 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n"); 265 err = -EINVAL; 266 goto err_reset; 267 } 268 #endif 269 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC 270 if (ehci->big_endian_desc) { 271 dev_err(&dev->dev, 272 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n"); 273 err = -EINVAL; 274 goto err_reset; 275 } 276 #endif 277 278 if (pdata->power_on) { 279 err = pdata->power_on(dev); 280 if (err < 0) 281 goto err_reset; 282 } 283 284 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0); 285 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem); 286 if (IS_ERR(hcd->regs)) { 287 err = PTR_ERR(hcd->regs); 288 goto err_power; 289 } 290 hcd->rsrc_start = res_mem->start; 291 hcd->rsrc_len = resource_size(res_mem); 292 293 err = usb_add_hcd(hcd, irq, IRQF_SHARED); 294 if (err) 295 goto err_power; 296 297 device_wakeup_enable(hcd->self.controller); 298 device_enable_async_suspend(hcd->self.controller); 299 platform_set_drvdata(dev, hcd); 300 301 return err; 302 303 err_power: 304 if (pdata->power_off) 305 pdata->power_off(dev); 306 err_reset: 307 reset_control_assert(priv->rsts); 308 err_put_clks: 309 while (--clk >= 0) 310 clk_put(priv->clks[clk]); 311 err_put_hcd: 312 if (pdata == &ehci_platform_defaults) 313 dev->dev.platform_data = NULL; 314 315 usb_put_hcd(hcd); 316 317 return err; 318 } 319 320 static int ehci_platform_remove(struct platform_device *dev) 321 { 322 struct usb_hcd *hcd = platform_get_drvdata(dev); 323 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev); 324 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd); 325 int clk; 326 327 usb_remove_hcd(hcd); 328 329 if (pdata->power_off) 330 pdata->power_off(dev); 331 332 reset_control_assert(priv->rsts); 333 334 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) 335 clk_put(priv->clks[clk]); 336 337 usb_put_hcd(hcd); 338 339 if (pdata == &ehci_platform_defaults) 340 dev->dev.platform_data = NULL; 341 342 return 0; 343 } 344 345 #ifdef CONFIG_PM_SLEEP 346 static int ehci_platform_suspend(struct device *dev) 347 { 348 struct usb_hcd *hcd = dev_get_drvdata(dev); 349 struct usb_ehci_pdata *pdata = dev_get_platdata(dev); 350 struct platform_device *pdev = to_platform_device(dev); 351 bool do_wakeup = device_may_wakeup(dev); 352 int ret; 353 354 ret = ehci_suspend(hcd, do_wakeup); 355 if (ret) 356 return ret; 357 358 if (pdata->power_suspend) 359 pdata->power_suspend(pdev); 360 361 return ret; 362 } 363 364 static int ehci_platform_resume(struct device *dev) 365 { 366 struct usb_hcd *hcd = dev_get_drvdata(dev); 367 struct usb_ehci_pdata *pdata = dev_get_platdata(dev); 368 struct platform_device *pdev = to_platform_device(dev); 369 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd); 370 struct device *companion_dev; 371 372 if (pdata->power_on) { 373 int err = pdata->power_on(pdev); 374 if (err < 0) 375 return err; 376 } 377 378 companion_dev = usb_of_get_companion_dev(hcd->self.controller); 379 if (companion_dev) { 380 device_pm_wait_for_dev(hcd->self.controller, companion_dev); 381 put_device(companion_dev); 382 } 383 384 ehci_resume(hcd, priv->reset_on_resume); 385 return 0; 386 } 387 #endif /* CONFIG_PM_SLEEP */ 388 389 static const struct of_device_id vt8500_ehci_ids[] = { 390 { .compatible = "via,vt8500-ehci", }, 391 { .compatible = "wm,prizm-ehci", }, 392 { .compatible = "generic-ehci", }, 393 { .compatible = "cavium,octeon-6335-ehci", }, 394 {} 395 }; 396 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids); 397 398 static const struct acpi_device_id ehci_acpi_match[] = { 399 { "PNP0D20", 0 }, /* EHCI controller without debug */ 400 { } 401 }; 402 MODULE_DEVICE_TABLE(acpi, ehci_acpi_match); 403 404 static const struct platform_device_id ehci_platform_table[] = { 405 { "ehci-platform", 0 }, 406 { } 407 }; 408 MODULE_DEVICE_TABLE(platform, ehci_platform_table); 409 410 static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend, 411 ehci_platform_resume); 412 413 static struct platform_driver ehci_platform_driver = { 414 .id_table = ehci_platform_table, 415 .probe = ehci_platform_probe, 416 .remove = ehci_platform_remove, 417 .shutdown = usb_hcd_platform_shutdown, 418 .driver = { 419 .name = "ehci-platform", 420 .pm = &ehci_platform_pm_ops, 421 .of_match_table = vt8500_ehci_ids, 422 .acpi_match_table = ACPI_PTR(ehci_acpi_match), 423 } 424 }; 425 426 static int __init ehci_platform_init(void) 427 { 428 if (usb_disabled()) 429 return -ENODEV; 430 431 pr_info("%s: " DRIVER_DESC "\n", hcd_name); 432 433 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides); 434 return platform_driver_register(&ehci_platform_driver); 435 } 436 module_init(ehci_platform_init); 437 438 static void __exit ehci_platform_cleanup(void) 439 { 440 platform_driver_unregister(&ehci_platform_driver); 441 } 442 module_exit(ehci_platform_cleanup); 443 444 MODULE_DESCRIPTION(DRIVER_DESC); 445 MODULE_AUTHOR("Hauke Mehrtens"); 446 MODULE_AUTHOR("Alan Stern"); 447 MODULE_LICENSE("GPL"); 448