1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2011 Marvell International Ltd. All rights reserved.
4 * Author: Chao Xie <chao.xie@marvell.com>
5 * Neil Zhang <zhangwm@marvell.com>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/platform_device.h>
11 #include <linux/clk.h>
12 #include <linux/err.h>
13 #include <linux/usb/otg.h>
14 #include <linux/usb/of.h>
15 #include <linux/platform_data/mv_usb.h>
18 #include <linux/usb/hcd.h>
23 #define U2x_CAPREGS_OFFSET 0x100
25 #define CAPLENGTH_MASK (0xff)
27 #define hcd_to_ehci_hcd_mv(h) ((struct ehci_hcd_mv *)hcd_to_ehci(h)->priv)
30 /* Which mode does this ehci running OTG/Host ? */
34 void __iomem *cap_regs;
35 void __iomem *op_regs;
42 int (*set_vbus)(unsigned int vbus);
45 static int mv_ehci_enable(struct ehci_hcd_mv *ehci_mv)
49 retval = clk_prepare_enable(ehci_mv->clk);
53 retval = phy_init(ehci_mv->phy);
55 clk_disable_unprepare(ehci_mv->clk);
60 static void mv_ehci_disable(struct ehci_hcd_mv *ehci_mv)
62 phy_exit(ehci_mv->phy);
63 clk_disable_unprepare(ehci_mv->clk);
66 static int mv_ehci_reset(struct usb_hcd *hcd)
68 struct device *dev = hcd->self.controller;
69 struct ehci_hcd_mv *ehci_mv = hcd_to_ehci_hcd_mv(hcd);
70 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
74 if (ehci_mv == NULL) {
75 dev_err(dev, "Can not find private ehci data\n");
81 retval = ehci_setup(hcd);
83 dev_err(dev, "ehci_setup failed %d\n", retval);
85 if (of_usb_get_phy_mode(dev->of_node) == USBPHY_INTERFACE_MODE_HSIC) {
86 status = ehci_readl(ehci, &ehci->regs->port_status[0]);
87 status |= PORT_TEST_FORCE;
88 ehci_writel(ehci, status, &ehci->regs->port_status[0]);
89 status &= ~PORT_TEST_FORCE;
90 ehci_writel(ehci, status, &ehci->regs->port_status[0]);
96 static struct hc_driver __read_mostly ehci_platform_hc_driver;
98 static const struct ehci_driver_overrides platform_overrides __initconst = {
99 .reset = mv_ehci_reset,
100 .extra_priv_size = sizeof(struct ehci_hcd_mv),
103 static int mv_ehci_probe(struct platform_device *pdev)
105 struct mv_usb_platform_data *pdata = dev_get_platdata(&pdev->dev);
107 struct ehci_hcd *ehci;
108 struct ehci_hcd_mv *ehci_mv;
117 hcd = usb_create_hcd(&ehci_platform_hc_driver, &pdev->dev, dev_name(&pdev->dev));
121 platform_set_drvdata(pdev, hcd);
122 ehci_mv = hcd_to_ehci_hcd_mv(hcd);
124 ehci_mv->mode = MV_USB_MODE_HOST;
126 ehci_mv->mode = pdata->mode;
127 ehci_mv->set_vbus = pdata->set_vbus;
130 ehci_mv->phy = devm_phy_optional_get(&pdev->dev, "usb");
131 if (IS_ERR(ehci_mv->phy)) {
132 retval = PTR_ERR(ehci_mv->phy);
133 if (retval != -EPROBE_DEFER)
134 dev_err(&pdev->dev, "Failed to get phy.\n");
138 ehci_mv->clk = devm_clk_get(&pdev->dev, NULL);
139 if (IS_ERR(ehci_mv->clk)) {
140 dev_err(&pdev->dev, "error getting clock\n");
141 retval = PTR_ERR(ehci_mv->clk);
145 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
146 ehci_mv->base = devm_ioremap_resource(&pdev->dev, r);
147 if (IS_ERR(ehci_mv->base)) {
148 retval = PTR_ERR(ehci_mv->base);
152 retval = mv_ehci_enable(ehci_mv);
154 dev_err(&pdev->dev, "init phy error %d\n", retval);
159 (void __iomem *) ((unsigned long) ehci_mv->base + U2x_CAPREGS_OFFSET);
160 offset = readl(ehci_mv->cap_regs) & CAPLENGTH_MASK;
162 (void __iomem *) ((unsigned long) ehci_mv->cap_regs + offset);
164 hcd->rsrc_start = r->start;
165 hcd->rsrc_len = resource_size(r);
166 hcd->regs = ehci_mv->op_regs;
168 retval = platform_get_irq(pdev, 0);
170 goto err_disable_clk;
173 ehci = hcd_to_ehci(hcd);
174 ehci->caps = (struct ehci_caps __iomem *) ehci_mv->cap_regs;
176 if (ehci_mv->mode == MV_USB_MODE_OTG) {
177 ehci_mv->otg = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
178 if (IS_ERR(ehci_mv->otg)) {
179 retval = PTR_ERR(ehci_mv->otg);
181 if (retval == -ENXIO)
182 dev_info(&pdev->dev, "MV_USB_MODE_OTG "
183 "must have CONFIG_USB_PHY enabled\n");
186 "unable to find transceiver\n");
187 goto err_disable_clk;
190 retval = otg_set_host(ehci_mv->otg->otg, &hcd->self);
193 "unable to register with transceiver\n");
195 goto err_disable_clk;
197 /* otg will enable clock before use as host */
198 mv_ehci_disable(ehci_mv);
200 if (ehci_mv->set_vbus)
201 ehci_mv->set_vbus(1);
203 retval = usb_add_hcd(hcd, hcd->irq, IRQF_SHARED);
206 "failed to add hcd with err %d\n", retval);
209 device_wakeup_enable(hcd->self.controller);
212 if (of_usb_get_phy_mode(pdev->dev.of_node) == USBPHY_INTERFACE_MODE_HSIC) {
213 status = ehci_readl(ehci, &ehci->regs->port_status[0]);
214 /* These "reserved" bits actually enable HSIC mode. */
216 status &= ~GENMASK(31, 30);
217 ehci_writel(ehci, status, &ehci->regs->port_status[0]);
221 "successful find EHCI device with regs 0x%p irq %d"
222 " working in %s mode\n", hcd->regs, hcd->irq,
223 ehci_mv->mode == MV_USB_MODE_OTG ? "OTG" : "Host");
228 if (ehci_mv->set_vbus)
229 ehci_mv->set_vbus(0);
231 mv_ehci_disable(ehci_mv);
238 static int mv_ehci_remove(struct platform_device *pdev)
240 struct usb_hcd *hcd = platform_get_drvdata(pdev);
241 struct ehci_hcd_mv *ehci_mv = hcd_to_ehci_hcd_mv(hcd);
243 if (hcd->rh_registered)
246 if (!IS_ERR_OR_NULL(ehci_mv->otg))
247 otg_set_host(ehci_mv->otg->otg, NULL);
249 if (ehci_mv->mode == MV_USB_MODE_HOST) {
250 if (ehci_mv->set_vbus)
251 ehci_mv->set_vbus(0);
253 mv_ehci_disable(ehci_mv);
261 static const struct platform_device_id ehci_id_table[] = {
267 static void mv_ehci_shutdown(struct platform_device *pdev)
269 struct usb_hcd *hcd = platform_get_drvdata(pdev);
271 if (!hcd->rh_registered)
274 if (hcd->driver->shutdown)
275 hcd->driver->shutdown(hcd);
278 static const struct of_device_id ehci_mv_dt_ids[] = {
279 { .compatible = "marvell,pxau2o-ehci", },
283 static struct platform_driver ehci_mv_driver = {
284 .probe = mv_ehci_probe,
285 .remove = mv_ehci_remove,
286 .shutdown = mv_ehci_shutdown,
289 .bus = &platform_bus_type,
290 .of_match_table = ehci_mv_dt_ids,
292 .id_table = ehci_id_table,
295 static int __init ehci_platform_init(void)
300 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
301 return platform_driver_register(&ehci_mv_driver);
303 module_init(ehci_platform_init);
305 static void __exit ehci_platform_cleanup(void)
307 platform_driver_unregister(&ehci_mv_driver);
309 module_exit(ehci_platform_cleanup);
311 MODULE_DESCRIPTION("Marvell EHCI driver");
312 MODULE_AUTHOR("Chao Xie <chao.xie@marvell.com>");
313 MODULE_AUTHOR("Neil Zhang <zhangwm@marvell.com>");
314 MODULE_ALIAS("mv-ehci");
315 MODULE_LICENSE("GPL");
316 MODULE_DEVICE_TABLE(of, ehci_mv_dt_ids);