2 * xhci-plat.c - xHCI host controller driver platform Bus Glue.
4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
5 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
7 * A lot of code borrowed from the Linux xHCI driver.
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.
14 #include <linux/clk.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/module.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>
25 #include "xhci-plat.h"
26 #include "xhci-mvebu.h"
27 #include "xhci-rcar.h"
29 static struct hc_driver __read_mostly xhci_plat_hc_driver
;
31 static int xhci_plat_setup(struct usb_hcd
*hcd
);
32 static int xhci_plat_start(struct usb_hcd
*hcd
);
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
,
40 static void xhci_plat_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
43 * As of now platform drivers don't provide MSI support so we ensure
44 * here that the generic code does not try to make a pci_dev from our
45 * dev struct in order to setup MSI
47 xhci
->quirks
|= XHCI_PLAT
;
50 /* called during probe() after chip reset completes */
51 static int xhci_plat_setup(struct usb_hcd
*hcd
)
55 if (xhci_plat_type_is(hcd
, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2
) ||
56 xhci_plat_type_is(hcd
, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3
)) {
57 ret
= xhci_rcar_init_quirk(hcd
);
62 return xhci_gen_setup(hcd
, xhci_plat_quirks
);
65 static int xhci_plat_start(struct usb_hcd
*hcd
)
67 if (xhci_plat_type_is(hcd
, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2
) ||
68 xhci_plat_type_is(hcd
, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3
))
75 static const struct xhci_plat_priv xhci_plat_marvell_armada
= {
76 .type
= XHCI_PLAT_TYPE_MARVELL_ARMADA
,
79 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2
= {
80 .type
= XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2
,
81 .firmware_name
= XHCI_RCAR_FIRMWARE_NAME_V1
,
84 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3
= {
85 .type
= XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3
,
86 .firmware_name
= XHCI_RCAR_FIRMWARE_NAME_V2
,
89 static const struct of_device_id usb_xhci_of_match
[] = {
91 .compatible
= "generic-xhci",
93 .compatible
= "xhci-platform",
95 .compatible
= "marvell,armada-375-xhci",
96 .data
= &xhci_plat_marvell_armada
,
98 .compatible
= "marvell,armada-380-xhci",
99 .data
= &xhci_plat_marvell_armada
,
101 .compatible
= "renesas,xhci-r8a7790",
102 .data
= &xhci_plat_renesas_rcar_gen2
,
104 .compatible
= "renesas,xhci-r8a7791",
105 .data
= &xhci_plat_renesas_rcar_gen2
,
107 .compatible
= "renesas,xhci-r8a7793",
108 .data
= &xhci_plat_renesas_rcar_gen2
,
110 .compatible
= "renesas,xhci-r8a7795",
111 .data
= &xhci_plat_renesas_rcar_gen3
,
115 MODULE_DEVICE_TABLE(of
, usb_xhci_of_match
);
118 static int xhci_plat_probe(struct platform_device
*pdev
)
120 struct device_node
*node
= pdev
->dev
.of_node
;
121 struct usb_xhci_pdata
*pdata
= dev_get_platdata(&pdev
->dev
);
122 const struct of_device_id
*match
;
123 const struct hc_driver
*driver
;
124 struct xhci_hcd
*xhci
;
125 struct resource
*res
;
134 driver
= &xhci_plat_hc_driver
;
136 irq
= platform_get_irq(pdev
, 0);
140 /* Try to set 64-bit DMA first */
141 if (WARN_ON(!pdev
->dev
.dma_mask
))
142 /* Platform did not initialize dma_mask */
143 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
,
146 ret
= dma_set_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(64));
148 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
150 ret
= dma_set_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
155 hcd
= usb_create_hcd(driver
, &pdev
->dev
, dev_name(&pdev
->dev
));
159 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
160 hcd
->regs
= devm_ioremap_resource(&pdev
->dev
, res
);
161 if (IS_ERR(hcd
->regs
)) {
162 ret
= PTR_ERR(hcd
->regs
);
166 hcd
->rsrc_start
= res
->start
;
167 hcd
->rsrc_len
= resource_size(res
);
170 * Not all platforms have a clk so it is not an error if the
171 * clock does not exists.
173 clk
= devm_clk_get(&pdev
->dev
, NULL
);
175 ret
= clk_prepare_enable(clk
);
180 xhci
= hcd_to_xhci(hcd
);
181 match
= of_match_node(usb_xhci_of_match
, node
);
183 const struct xhci_plat_priv
*priv_match
= match
->data
;
184 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
186 /* Just copy data for now */
190 if (xhci_plat_type_is(hcd
, XHCI_PLAT_TYPE_MARVELL_ARMADA
)) {
191 ret
= xhci_mvebu_mbus_init_quirk(pdev
);
196 device_wakeup_enable(hcd
->self
.controller
);
199 xhci
->main_hcd
= hcd
;
200 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, &pdev
->dev
,
201 dev_name(&pdev
->dev
), hcd
);
202 if (!xhci
->shared_hcd
) {
207 if ((node
&& of_property_read_bool(node
, "usb3-lpm-capable")) ||
208 (pdata
&& pdata
->usb3_lpm_capable
))
209 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
211 if (HCC_MAX_PSA(xhci
->hcc_params
) >= 4)
212 xhci
->shared_hcd
->can_do_streams
= 1;
214 hcd
->usb_phy
= devm_usb_get_phy_by_phandle(&pdev
->dev
, "usb-phy", 0);
215 if (IS_ERR(hcd
->usb_phy
)) {
216 ret
= PTR_ERR(hcd
->usb_phy
);
217 if (ret
== -EPROBE_DEFER
)
221 ret
= usb_phy_init(hcd
->usb_phy
);
226 ret
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
228 goto disable_usb_phy
;
230 ret
= usb_add_hcd(xhci
->shared_hcd
, irq
, IRQF_SHARED
);
232 goto dealloc_usb2_hcd
;
241 usb_phy_shutdown(hcd
->usb_phy
);
244 usb_put_hcd(xhci
->shared_hcd
);
248 clk_disable_unprepare(clk
);
256 static int xhci_plat_remove(struct platform_device
*dev
)
258 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
259 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
260 struct clk
*clk
= xhci
->clk
;
262 usb_remove_hcd(xhci
->shared_hcd
);
263 usb_phy_shutdown(hcd
->usb_phy
);
266 usb_put_hcd(xhci
->shared_hcd
);
269 clk_disable_unprepare(clk
);
275 #ifdef CONFIG_PM_SLEEP
276 static int xhci_plat_suspend(struct device
*dev
)
278 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
279 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
282 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
283 * to do wakeup during suspend. Since xhci_plat_suspend is currently
284 * only designed for system suspend, device_may_wakeup() is enough
285 * to dertermine whether host is allowed to do wakeup. Need to
286 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
287 * also applies to runtime suspend.
289 return xhci_suspend(xhci
, device_may_wakeup(dev
));
292 static int xhci_plat_resume(struct device
*dev
)
294 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
295 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
297 return xhci_resume(xhci
, 0);
300 static const struct dev_pm_ops xhci_plat_pm_ops
= {
301 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend
, xhci_plat_resume
)
303 #define DEV_PM_OPS (&xhci_plat_pm_ops)
305 #define DEV_PM_OPS NULL
306 #endif /* CONFIG_PM */
308 static const struct acpi_device_id usb_xhci_acpi_match
[] = {
309 /* XHCI-compliant USB Controller */
313 MODULE_DEVICE_TABLE(acpi
, usb_xhci_acpi_match
);
315 static struct platform_driver usb_xhci_driver
= {
316 .probe
= xhci_plat_probe
,
317 .remove
= xhci_plat_remove
,
321 .of_match_table
= of_match_ptr(usb_xhci_of_match
),
322 .acpi_match_table
= ACPI_PTR(usb_xhci_acpi_match
),
325 MODULE_ALIAS("platform:xhci-hcd");
327 static int __init
xhci_plat_init(void)
329 xhci_init_driver(&xhci_plat_hc_driver
, &xhci_plat_overrides
);
330 return platform_driver_register(&usb_xhci_driver
);
332 module_init(xhci_plat_init
);
334 static void __exit
xhci_plat_exit(void)
336 platform_driver_unregister(&usb_xhci_driver
);
338 module_exit(xhci_plat_exit
);
340 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
341 MODULE_LICENSE("GPL");