1// SPDX-License-Identifier: GPL-2.0
2/*
3* OHCI HCD (Host Controller Driver) for USB.
4*
5* Copyright (C) 2010 ST Microelectronics.
6* Deepak Sikri<deepak.sikri@st.com>
7*
8* Based on various ohci-*.c drivers
9*/
10
11#include <linux/clk.h>
12#include <linux/dma-mapping.h>
13#include <linux/io.h>
14#include <linux/kernel.h>
15#include <linux/module.h>
16#include <linux/of.h>
17#include <linux/platform_device.h>
18#include <linux/signal.h>
19#include <linux/usb.h>
20#include <linux/usb/hcd.h>
21
22#include "ohci.h"
23
24#define DRIVER_DESC "OHCI SPEAr driver"
25
26static const char hcd_name[] = "SPEAr-ohci";
27struct spear_ohci {
28	struct clk *clk;
29};
30
31#define to_spear_ohci(hcd)     (struct spear_ohci *)(hcd_to_ohci(hcd)->priv)
32
33static struct hc_driver __read_mostly ohci_spear_hc_driver;
34
35static int spear_ohci_hcd_drv_probe(struct platform_device *pdev)
36{
37	const struct hc_driver *driver = &ohci_spear_hc_driver;
38	struct usb_hcd *hcd = NULL;
39	struct clk *usbh_clk;
40	struct spear_ohci *sohci_p;
41	struct resource *res;
42	int retval, irq;
43
44	irq = platform_get_irq(pdev, 0);
45	if (irq < 0) {
46		retval = irq;
47		goto fail;
48	}
49
50	/*
51	 * Right now device-tree probed devices don't get dma_mask set.
52	 * Since shared usb code relies on it, set it here for now.
53	 * Once we have dma capability bindings this can go away.
54	 */
55	retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
56	if (retval)
57		goto fail;
58
59	usbh_clk = devm_clk_get(&pdev->dev, NULL);
60	if (IS_ERR(usbh_clk)) {
61		dev_err(&pdev->dev, "Error getting interface clock\n");
62		retval = PTR_ERR(usbh_clk);
63		goto fail;
64	}
65
66	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
67	if (!hcd) {
68		retval = -ENOMEM;
69		goto fail;
70	}
71
72	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
73	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
74	if (IS_ERR(hcd->regs)) {
75		retval = PTR_ERR(hcd->regs);
76		goto err_put_hcd;
77	}
78
79	hcd->rsrc_start = pdev->resource[0].start;
80	hcd->rsrc_len = resource_size(res);
81
82	sohci_p = to_spear_ohci(hcd);
83	sohci_p->clk = usbh_clk;
84
85	clk_prepare_enable(sohci_p->clk);
86
87	retval = usb_add_hcd(hcd, platform_get_irq(pdev, 0), 0);
88	if (retval == 0) {
89		device_wakeup_enable(hcd->self.controller);
90		return retval;
91	}
92
93	clk_disable_unprepare(sohci_p->clk);
94err_put_hcd:
95	usb_put_hcd(hcd);
96fail:
97	dev_err(&pdev->dev, "init fail, %d\n", retval);
98
99	return retval;
100}
101
102static int spear_ohci_hcd_drv_remove(struct platform_device *pdev)
103{
104	struct usb_hcd *hcd = platform_get_drvdata(pdev);
105	struct spear_ohci *sohci_p = to_spear_ohci(hcd);
106
107	usb_remove_hcd(hcd);
108	if (sohci_p->clk)
109		clk_disable_unprepare(sohci_p->clk);
110
111	usb_put_hcd(hcd);
112	return 0;
113}
114
115#if defined(CONFIG_PM)
116static int spear_ohci_hcd_drv_suspend(struct platform_device *pdev,
117		pm_message_t message)
118{
119	struct usb_hcd *hcd = platform_get_drvdata(pdev);
120	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);
121	struct spear_ohci *sohci_p = to_spear_ohci(hcd);
122	bool do_wakeup = device_may_wakeup(&pdev->dev);
123	int ret;
124
125	if (time_before(jiffies, ohci->next_statechange))
126		msleep(5);
127	ohci->next_statechange = jiffies;
128
129	ret = ohci_suspend(hcd, do_wakeup);
130	if (ret)
131		return ret;
132
133	clk_disable_unprepare(sohci_p->clk);
134
135	return ret;
136}
137
138static int spear_ohci_hcd_drv_resume(struct platform_device *dev)
139{
140	struct usb_hcd *hcd = platform_get_drvdata(dev);
141	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);
142	struct spear_ohci *sohci_p = to_spear_ohci(hcd);
143
144	if (time_before(jiffies, ohci->next_statechange))
145		msleep(5);
146	ohci->next_statechange = jiffies;
147
148	clk_prepare_enable(sohci_p->clk);
149	ohci_resume(hcd, false);
150	return 0;
151}
152#endif
153
154static const struct of_device_id spear_ohci_id_table[] = {
155	{ .compatible = "st,spear600-ohci", },
156	{ },
157};
158MODULE_DEVICE_TABLE(of, spear_ohci_id_table);
159
160/* Driver definition to register with the platform bus */
161static struct platform_driver spear_ohci_hcd_driver = {
162	.probe =	spear_ohci_hcd_drv_probe,
163	.remove =	spear_ohci_hcd_drv_remove,
164#ifdef CONFIG_PM
165	.suspend =	spear_ohci_hcd_drv_suspend,
166	.resume =	spear_ohci_hcd_drv_resume,
167#endif
168	.driver = {
169		.name = "spear-ohci",
170		.of_match_table = spear_ohci_id_table,
171	},
172};
173
174static const struct ohci_driver_overrides spear_overrides __initconst = {
175	.extra_priv_size = sizeof(struct spear_ohci),
176};
177static int __init ohci_spear_init(void)
178{
179	if (usb_disabled())
180		return -ENODEV;
181
182	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
183
184	ohci_init_driver(&ohci_spear_hc_driver, &spear_overrides);
185	return platform_driver_register(&spear_ohci_hcd_driver);
186}
187module_init(ohci_spear_init);
188
189static void __exit ohci_spear_cleanup(void)
190{
191	platform_driver_unregister(&spear_ohci_hcd_driver);
192}
193module_exit(ohci_spear_cleanup);
194
195MODULE_DESCRIPTION(DRIVER_DESC);
196MODULE_AUTHOR("Deepak Sikri");
197MODULE_LICENSE("GPL v2");
198MODULE_ALIAS("platform:spear-ohci");
199