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_priv_plat_start(struct usb_hcd
*hcd
)
42 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
45 priv
->plat_start(hcd
);
48 static int xhci_priv_init_quirk(struct usb_hcd
*hcd
)
50 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
52 if (!priv
->init_quirk
)
55 return priv
->init_quirk(hcd
);
58 static void xhci_plat_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
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
65 xhci
->quirks
|= XHCI_PLAT
;
68 /* called during probe() after chip reset completes */
69 static int xhci_plat_setup(struct usb_hcd
*hcd
)
74 ret
= xhci_priv_init_quirk(hcd
);
78 return xhci_gen_setup(hcd
, xhci_plat_quirks
);
81 static int xhci_plat_start(struct usb_hcd
*hcd
)
83 xhci_priv_plat_start(hcd
);
88 static const struct xhci_plat_priv xhci_plat_marvell_armada
= {
89 .init_quirk
= xhci_mvebu_mbus_init_quirk
,
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
,
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
,
104 static const struct of_device_id usb_xhci_of_match
[] = {
106 .compatible
= "generic-xhci",
108 .compatible
= "xhci-platform",
110 .compatible
= "marvell,armada-375-xhci",
111 .data
= &xhci_plat_marvell_armada
,
113 .compatible
= "marvell,armada-380-xhci",
114 .data
= &xhci_plat_marvell_armada
,
116 .compatible
= "renesas,xhci-r8a7790",
117 .data
= &xhci_plat_renesas_rcar_gen2
,
119 .compatible
= "renesas,xhci-r8a7791",
120 .data
= &xhci_plat_renesas_rcar_gen2
,
122 .compatible
= "renesas,xhci-r8a7793",
123 .data
= &xhci_plat_renesas_rcar_gen2
,
125 .compatible
= "renesas,xhci-r8a7795",
126 .data
= &xhci_plat_renesas_rcar_gen3
,
128 .compatible
= "renesas,rcar-gen2-xhci",
129 .data
= &xhci_plat_renesas_rcar_gen2
,
131 .compatible
= "renesas,rcar-gen3-xhci",
132 .data
= &xhci_plat_renesas_rcar_gen3
,
136 MODULE_DEVICE_TABLE(of
, usb_xhci_of_match
);
139 static int xhci_plat_probe(struct platform_device
*pdev
)
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
;
155 driver
= &xhci_plat_hc_driver
;
157 irq
= platform_get_irq(pdev
, 0);
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
,
167 ret
= dma_set_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(64));
169 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
171 ret
= dma_set_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
176 hcd
= usb_create_hcd(driver
, &pdev
->dev
, dev_name(&pdev
->dev
));
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
);
187 hcd
->rsrc_start
= res
->start
;
188 hcd
->rsrc_len
= resource_size(res
);
191 * Not all platforms have a clk so it is not an error if the
192 * clock does not exists.
194 clk
= devm_clk_get(&pdev
->dev
, NULL
);
196 ret
= clk_prepare_enable(clk
);
201 xhci
= hcd_to_xhci(hcd
);
202 match
= of_match_node(usb_xhci_of_match
, node
);
204 const struct xhci_plat_priv
*priv_match
= match
->data
;
205 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
207 /* Just copy data for now */
212 device_wakeup_enable(hcd
->self
.controller
);
215 xhci
->main_hcd
= hcd
;
216 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, &pdev
->dev
,
217 dev_name(&pdev
->dev
), hcd
);
218 if (!xhci
->shared_hcd
) {
223 if ((node
&& of_property_read_bool(node
, "usb3-lpm-capable")) ||
224 (pdata
&& pdata
->usb3_lpm_capable
))
225 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
227 if (HCC_MAX_PSA(xhci
->hcc_params
) >= 4)
228 xhci
->shared_hcd
->can_do_streams
= 1;
230 hcd
->usb_phy
= devm_usb_get_phy_by_phandle(&pdev
->dev
, "usb-phy", 0);
231 if (IS_ERR(hcd
->usb_phy
)) {
232 ret
= PTR_ERR(hcd
->usb_phy
);
233 if (ret
== -EPROBE_DEFER
)
237 ret
= usb_phy_init(hcd
->usb_phy
);
242 ret
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
244 goto disable_usb_phy
;
246 ret
= usb_add_hcd(xhci
->shared_hcd
, irq
, IRQF_SHARED
);
248 goto dealloc_usb2_hcd
;
257 usb_phy_shutdown(hcd
->usb_phy
);
260 usb_put_hcd(xhci
->shared_hcd
);
264 clk_disable_unprepare(clk
);
272 static int xhci_plat_remove(struct platform_device
*dev
)
274 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
275 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
276 struct clk
*clk
= xhci
->clk
;
278 usb_remove_hcd(xhci
->shared_hcd
);
279 usb_phy_shutdown(hcd
->usb_phy
);
282 usb_put_hcd(xhci
->shared_hcd
);
285 clk_disable_unprepare(clk
);
291 #ifdef CONFIG_PM_SLEEP
292 static int xhci_plat_suspend(struct device
*dev
)
294 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
295 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
298 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
299 * to do wakeup during suspend. Since xhci_plat_suspend is currently
300 * only designed for system suspend, device_may_wakeup() is enough
301 * to dertermine whether host is allowed to do wakeup. Need to
302 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
303 * also applies to runtime suspend.
305 return xhci_suspend(xhci
, device_may_wakeup(dev
));
308 static int xhci_plat_resume(struct device
*dev
)
310 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
311 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
313 return xhci_resume(xhci
, 0);
316 static const struct dev_pm_ops xhci_plat_pm_ops
= {
317 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend
, xhci_plat_resume
)
319 #define DEV_PM_OPS (&xhci_plat_pm_ops)
321 #define DEV_PM_OPS NULL
322 #endif /* CONFIG_PM */
324 static const struct acpi_device_id usb_xhci_acpi_match
[] = {
325 /* XHCI-compliant USB Controller */
329 MODULE_DEVICE_TABLE(acpi
, usb_xhci_acpi_match
);
331 static struct platform_driver usb_xhci_driver
= {
332 .probe
= xhci_plat_probe
,
333 .remove
= xhci_plat_remove
,
337 .of_match_table
= of_match_ptr(usb_xhci_of_match
),
338 .acpi_match_table
= ACPI_PTR(usb_xhci_acpi_match
),
341 MODULE_ALIAS("platform:xhci-hcd");
343 static int __init
xhci_plat_init(void)
345 xhci_init_driver(&xhci_plat_hc_driver
, &xhci_plat_overrides
);
346 return platform_driver_register(&usb_xhci_driver
);
348 module_init(xhci_plat_init
);
350 static void __exit
xhci_plat_exit(void)
352 platform_driver_unregister(&usb_xhci_driver
);
354 module_exit(xhci_plat_exit
);
356 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
357 MODULE_LICENSE("GPL");