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