1 /* 2 * xhci-plat.c - xHCI host controller driver platform Bus Glue. 3 * 4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com 5 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de> 6 * 7 * A lot of code borrowed from the Linux xHCI driver. 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * version 2 as published by the Free Software Foundation. 12 */ 13 14 #include <linux/clk.h> 15 #include <linux/dma-mapping.h> 16 #include <linux/module.h> 17 #include <linux/of.h> 18 #include <linux/platform_device.h> 19 #include <linux/usb/phy.h> 20 #include <linux/slab.h> 21 #include <linux/usb/xhci_pdriver.h> 22 #include <linux/acpi.h> 23 24 #include "xhci.h" 25 #include "xhci-plat.h" 26 #include "xhci-mvebu.h" 27 #include "xhci-rcar.h" 28 29 static struct hc_driver __read_mostly xhci_plat_hc_driver; 30 31 static int xhci_plat_setup(struct usb_hcd *hcd); 32 static int xhci_plat_start(struct usb_hcd *hcd); 33 34 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { 35 .extra_priv_size = sizeof(struct xhci_plat_priv), 36 .reset = xhci_plat_setup, 37 .start = xhci_plat_start, 38 }; 39 40 static void xhci_priv_plat_start(struct usb_hcd *hcd) 41 { 42 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 43 44 if (priv->plat_start) 45 priv->plat_start(hcd); 46 } 47 48 static int xhci_priv_init_quirk(struct usb_hcd *hcd) 49 { 50 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 51 52 if (!priv->init_quirk) 53 return 0; 54 55 return priv->init_quirk(hcd); 56 } 57 58 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) 59 { 60 /* 61 * As of now platform drivers don't provide MSI support so we ensure 62 * here that the generic code does not try to make a pci_dev from our 63 * dev struct in order to setup MSI 64 */ 65 xhci->quirks |= XHCI_PLAT; 66 } 67 68 /* called during probe() after chip reset completes */ 69 static int xhci_plat_setup(struct usb_hcd *hcd) 70 { 71 int ret; 72 73 74 ret = xhci_priv_init_quirk(hcd); 75 if (ret) 76 return ret; 77 78 return xhci_gen_setup(hcd, xhci_plat_quirks); 79 } 80 81 static int xhci_plat_start(struct usb_hcd *hcd) 82 { 83 xhci_priv_plat_start(hcd); 84 return xhci_run(hcd); 85 } 86 87 #ifdef CONFIG_OF 88 static const struct xhci_plat_priv xhci_plat_marvell_armada = { 89 .init_quirk = xhci_mvebu_mbus_init_quirk, 90 }; 91 92 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { 93 .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, 94 .init_quirk = xhci_rcar_init_quirk, 95 .plat_start = xhci_rcar_start, 96 }; 97 98 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { 99 .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V2, 100 .init_quirk = xhci_rcar_init_quirk, 101 .plat_start = xhci_rcar_start, 102 }; 103 104 static const struct of_device_id usb_xhci_of_match[] = { 105 { 106 .compatible = "generic-xhci", 107 }, { 108 .compatible = "xhci-platform", 109 }, { 110 .compatible = "marvell,armada-375-xhci", 111 .data = &xhci_plat_marvell_armada, 112 }, { 113 .compatible = "marvell,armada-380-xhci", 114 .data = &xhci_plat_marvell_armada, 115 }, { 116 .compatible = "renesas,xhci-r8a7790", 117 .data = &xhci_plat_renesas_rcar_gen2, 118 }, { 119 .compatible = "renesas,xhci-r8a7791", 120 .data = &xhci_plat_renesas_rcar_gen2, 121 }, { 122 .compatible = "renesas,xhci-r8a7793", 123 .data = &xhci_plat_renesas_rcar_gen2, 124 }, { 125 .compatible = "renesas,xhci-r8a7795", 126 .data = &xhci_plat_renesas_rcar_gen3, 127 }, { 128 .compatible = "renesas,rcar-gen2-xhci", 129 .data = &xhci_plat_renesas_rcar_gen2, 130 }, { 131 .compatible = "renesas,rcar-gen3-xhci", 132 .data = &xhci_plat_renesas_rcar_gen3, 133 }, 134 {}, 135 }; 136 MODULE_DEVICE_TABLE(of, usb_xhci_of_match); 137 #endif 138 139 static int xhci_plat_probe(struct platform_device *pdev) 140 { 141 struct device_node *node = pdev->dev.of_node; 142 struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev); 143 const struct of_device_id *match; 144 const struct hc_driver *driver; 145 struct xhci_hcd *xhci; 146 struct resource *res; 147 struct usb_hcd *hcd; 148 struct clk *clk; 149 int ret; 150 int irq; 151 152 if (usb_disabled()) 153 return -ENODEV; 154 155 driver = &xhci_plat_hc_driver; 156 157 irq = platform_get_irq(pdev, 0); 158 if (irq < 0) 159 return -ENODEV; 160 161 /* Try to set 64-bit DMA first */ 162 if (WARN_ON(!pdev->dev.dma_mask)) 163 /* Platform did not initialize dma_mask */ 164 ret = dma_coerce_mask_and_coherent(&pdev->dev, 165 DMA_BIT_MASK(64)); 166 else 167 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64)); 168 169 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ 170 if (ret) { 171 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)); 172 if (ret) 173 return ret; 174 } 175 176 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev)); 177 if (!hcd) 178 return -ENOMEM; 179 180 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 181 hcd->regs = devm_ioremap_resource(&pdev->dev, res); 182 if (IS_ERR(hcd->regs)) { 183 ret = PTR_ERR(hcd->regs); 184 goto put_hcd; 185 } 186 187 hcd->rsrc_start = res->start; 188 hcd->rsrc_len = resource_size(res); 189 190 /* 191 * Not all platforms have a clk so it is not an error if the 192 * clock does not exists. 193 */ 194 clk = devm_clk_get(&pdev->dev, NULL); 195 if (!IS_ERR(clk)) { 196 ret = clk_prepare_enable(clk); 197 if (ret) 198 goto put_hcd; 199 } else if (PTR_ERR(clk) == -EPROBE_DEFER) { 200 ret = -EPROBE_DEFER; 201 goto put_hcd; 202 } 203 204 xhci = hcd_to_xhci(hcd); 205 match = of_match_node(usb_xhci_of_match, node); 206 if (match) { 207 const struct xhci_plat_priv *priv_match = match->data; 208 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 209 210 /* Just copy data for now */ 211 if (priv_match) 212 *priv = *priv_match; 213 } 214 215 device_wakeup_enable(hcd->self.controller); 216 217 xhci->clk = clk; 218 xhci->main_hcd = hcd; 219 xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev, 220 dev_name(&pdev->dev), hcd); 221 if (!xhci->shared_hcd) { 222 ret = -ENOMEM; 223 goto disable_clk; 224 } 225 226 if ((node && of_property_read_bool(node, "usb3-lpm-capable")) || 227 (pdata && pdata->usb3_lpm_capable)) 228 xhci->quirks |= XHCI_LPM_SUPPORT; 229 230 if (HCC_MAX_PSA(xhci->hcc_params) >= 4) 231 xhci->shared_hcd->can_do_streams = 1; 232 233 hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0); 234 if (IS_ERR(hcd->usb_phy)) { 235 ret = PTR_ERR(hcd->usb_phy); 236 if (ret == -EPROBE_DEFER) 237 goto put_usb3_hcd; 238 hcd->usb_phy = NULL; 239 } else { 240 ret = usb_phy_init(hcd->usb_phy); 241 if (ret) 242 goto put_usb3_hcd; 243 } 244 245 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 246 if (ret) 247 goto disable_usb_phy; 248 249 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); 250 if (ret) 251 goto dealloc_usb2_hcd; 252 253 return 0; 254 255 256 dealloc_usb2_hcd: 257 usb_remove_hcd(hcd); 258 259 disable_usb_phy: 260 usb_phy_shutdown(hcd->usb_phy); 261 262 put_usb3_hcd: 263 usb_put_hcd(xhci->shared_hcd); 264 265 disable_clk: 266 if (!IS_ERR(clk)) 267 clk_disable_unprepare(clk); 268 269 put_hcd: 270 usb_put_hcd(hcd); 271 272 return ret; 273 } 274 275 static int xhci_plat_remove(struct platform_device *dev) 276 { 277 struct usb_hcd *hcd = platform_get_drvdata(dev); 278 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 279 struct clk *clk = xhci->clk; 280 281 usb_remove_hcd(xhci->shared_hcd); 282 usb_phy_shutdown(hcd->usb_phy); 283 284 usb_remove_hcd(hcd); 285 usb_put_hcd(xhci->shared_hcd); 286 287 if (!IS_ERR(clk)) 288 clk_disable_unprepare(clk); 289 usb_put_hcd(hcd); 290 291 return 0; 292 } 293 294 #ifdef CONFIG_PM_SLEEP 295 static int xhci_plat_suspend(struct device *dev) 296 { 297 struct usb_hcd *hcd = dev_get_drvdata(dev); 298 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 299 300 /* 301 * xhci_suspend() needs `do_wakeup` to know whether host is allowed 302 * to do wakeup during suspend. Since xhci_plat_suspend is currently 303 * only designed for system suspend, device_may_wakeup() is enough 304 * to dertermine whether host is allowed to do wakeup. Need to 305 * reconsider this when xhci_plat_suspend enlarges its scope, e.g., 306 * also applies to runtime suspend. 307 */ 308 return xhci_suspend(xhci, device_may_wakeup(dev)); 309 } 310 311 static int xhci_plat_resume(struct device *dev) 312 { 313 struct usb_hcd *hcd = dev_get_drvdata(dev); 314 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 315 316 return xhci_resume(xhci, 0); 317 } 318 319 static const struct dev_pm_ops xhci_plat_pm_ops = { 320 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) 321 }; 322 #define DEV_PM_OPS (&xhci_plat_pm_ops) 323 #else 324 #define DEV_PM_OPS NULL 325 #endif /* CONFIG_PM */ 326 327 static const struct acpi_device_id usb_xhci_acpi_match[] = { 328 /* XHCI-compliant USB Controller */ 329 { "PNP0D10", }, 330 { } 331 }; 332 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); 333 334 static struct platform_driver usb_xhci_driver = { 335 .probe = xhci_plat_probe, 336 .remove = xhci_plat_remove, 337 .driver = { 338 .name = "xhci-hcd", 339 .pm = DEV_PM_OPS, 340 .of_match_table = of_match_ptr(usb_xhci_of_match), 341 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), 342 }, 343 }; 344 MODULE_ALIAS("platform:xhci-hcd"); 345 346 static int __init xhci_plat_init(void) 347 { 348 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); 349 return platform_driver_register(&usb_xhci_driver); 350 } 351 module_init(xhci_plat_init); 352 353 static void __exit xhci_plat_exit(void) 354 { 355 platform_driver_unregister(&usb_xhci_driver); 356 } 357 module_exit(xhci_plat_exit); 358 359 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); 360 MODULE_LICENSE("GPL"); 361