1// SPDX-License-Identifier: GPL-2.0
  2/*
  3* Driver for EHCI HCD on SPEAr SOC
  4*
  5* Copyright (C) 2010 ST Micro Electronics,
  6* Deepak Sikri <deepak.sikri@st.com>
  7*
  8* Based on various ehci-*.c drivers
  9*/
 10
 11#include <linux/clk.h>
 12#include <linux/dma-mapping.h>
 13#include <linux/io.h>
 14#include <linux/jiffies.h>
 15#include <linux/kernel.h>
 16#include <linux/module.h>
 17#include <linux/of.h>
 18#include <linux/platform_device.h>
 19#include <linux/pm.h>
 20#include <linux/usb.h>
 21#include <linux/usb/hcd.h>
 22
 23#include "ehci.h"
 24
 25#define DRIVER_DESC "EHCI SPEAr driver"
 26
 27struct spear_ehci {
 28	struct clk *clk;
 29};
 30
 31#define to_spear_ehci(hcd)	(struct spear_ehci *)(hcd_to_ehci(hcd)->priv)
 32
 33static struct hc_driver __read_mostly ehci_spear_hc_driver;
 34
 35static int __maybe_unused ehci_spear_drv_suspend(struct device *dev)
 36{
 37	struct usb_hcd *hcd = dev_get_drvdata(dev);
 38	bool do_wakeup = device_may_wakeup(dev);
 39
 40	return ehci_suspend(hcd, do_wakeup);
 41}
 42
 43static int __maybe_unused ehci_spear_drv_resume(struct device *dev)
 44{
 45	struct usb_hcd *hcd = dev_get_drvdata(dev);
 46
 47	ehci_resume(hcd, false);
 48	return 0;
 49}
 50
 51static SIMPLE_DEV_PM_OPS(ehci_spear_pm_ops, ehci_spear_drv_suspend,
 52		ehci_spear_drv_resume);
 53
 54static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
 55{
 56	struct usb_hcd *hcd ;
 57	struct spear_ehci *sehci;
 58	struct resource *res;
 59	struct clk *usbh_clk;
 60	const struct hc_driver *driver = &ehci_spear_hc_driver;
 61	int irq, retval;
 62
 63	if (usb_disabled())
 64		return -ENODEV;
 65
 66	irq = platform_get_irq(pdev, 0);
 67	if (irq < 0) {
 68		retval = irq;
 69		goto fail;
 70	}
 71
 72	/*
 73	 * Right now device-tree probed devices don't get dma_mask set.
 74	 * Since shared usb code relies on it, set it here for now.
 75	 * Once we have dma capability bindings this can go away.
 76	 */
 77	retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 78	if (retval)
 79		goto fail;
 80
 81	usbh_clk = devm_clk_get(&pdev->dev, NULL);
 82	if (IS_ERR(usbh_clk)) {
 83		dev_err(&pdev->dev, "Error getting interface clock\n");
 84		retval = PTR_ERR(usbh_clk);
 85		goto fail;
 86	}
 87
 88	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 89	if (!hcd) {
 90		retval = -ENOMEM;
 91		goto fail;
 92	}
 93
 94	hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
 95	if (IS_ERR(hcd->regs)) {
 96		retval = PTR_ERR(hcd->regs);
 97		goto err_put_hcd;
 98	}
 99	hcd->rsrc_start = res->start;
100	hcd->rsrc_len = resource_size(res);
101
102	sehci = to_spear_ehci(hcd);
103	sehci->clk = usbh_clk;
104
105	/* registers start at offset 0x0 */
106	hcd_to_ehci(hcd)->caps = hcd->regs;
107
108	retval = clk_prepare_enable(sehci->clk);
109	if (retval)
110		goto err_put_hcd;
111	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
112	if (retval)
113		goto err_stop_ehci;
114
115	device_wakeup_enable(hcd->self.controller);
116	return retval;
117
118err_stop_ehci:
119	clk_disable_unprepare(sehci->clk);
120err_put_hcd:
121	usb_put_hcd(hcd);
122fail:
123	dev_err(&pdev->dev, "init fail, %d\n", retval);
124
125	return retval ;
126}
127
128static void spear_ehci_hcd_drv_remove(struct platform_device *pdev)
129{
130	struct usb_hcd *hcd = platform_get_drvdata(pdev);
131	struct spear_ehci *sehci = to_spear_ehci(hcd);
132
133	usb_remove_hcd(hcd);
134
135	clk_disable_unprepare(sehci->clk);
136	usb_put_hcd(hcd);
137}
138
139static const struct of_device_id spear_ehci_id_table[] = {
140	{ .compatible = "st,spear600-ehci", },
141	{ },
142};
143MODULE_DEVICE_TABLE(of, spear_ehci_id_table);
144
145static struct platform_driver spear_ehci_hcd_driver = {
146	.probe		= spear_ehci_hcd_drv_probe,
147	.remove		= spear_ehci_hcd_drv_remove,
148	.shutdown	= usb_hcd_platform_shutdown,
149	.driver		= {
150		.name = "spear-ehci",
151		.bus = &platform_bus_type,
152		.pm = pm_ptr(&ehci_spear_pm_ops),
153		.of_match_table = spear_ehci_id_table,
154	}
155};
156
157static const struct ehci_driver_overrides spear_overrides __initconst = {
158	.extra_priv_size = sizeof(struct spear_ehci),
159};
160
161static int __init ehci_spear_init(void)
162{
163	if (usb_disabled())
164		return -ENODEV;
165
166	ehci_init_driver(&ehci_spear_hc_driver, &spear_overrides);
167	return platform_driver_register(&spear_ehci_hcd_driver);
168}
169module_init(ehci_spear_init);
170
171static void __exit ehci_spear_cleanup(void)
172{
173	platform_driver_unregister(&spear_ehci_hcd_driver);
174}
175module_exit(ehci_spear_cleanup);
176
177MODULE_DESCRIPTION(DRIVER_DESC);
178MODULE_ALIAS("platform:spear-ehci");
179MODULE_AUTHOR("Deepak Sikri");
180MODULE_LICENSE("GPL");