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