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