2 * Driver for EHCI HCD on SPEAR SOC
4 * Copyright (C) 2010 ST Micro Electronics,
5 * Deepak Sikri <deepak.sikri@st.com>
7 * Based on various ehci-*.c drivers
9 * This file is subject to the terms and conditions of the GNU General Public
10 * License. See the file COPYING in the main directory of this archive for
14 #include <linux/clk.h>
15 #include <linux/jiffies.h>
17 #include <linux/platform_device.h>
25 #define to_spear_ehci(hcd) (struct spear_ehci *)hcd_to_ehci(hcd)
27 static void spear_start_ehci(struct spear_ehci *ehci)
29 clk_enable(ehci->clk);
32 static void spear_stop_ehci(struct spear_ehci *ehci)
34 clk_disable(ehci->clk);
37 static int ehci_spear_setup(struct usb_hcd *hcd)
39 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
42 /* registers start at offset 0x0 */
43 ehci->caps = hcd->regs;
44 ehci->regs = hcd->regs + HC_LENGTH(ehci, ehci_readl(ehci,
45 &ehci->caps->hc_capbase));
46 /* cache this readonly data; minimize chip reads */
47 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
48 retval = ehci_halt(ehci);
52 retval = ehci_init(hcd);
57 ehci_port_power(ehci, 0);
62 static const struct hc_driver ehci_spear_hc_driver = {
63 .description = hcd_name,
64 .product_desc = "SPEAr EHCI",
65 .hcd_priv_size = sizeof(struct spear_ehci),
67 /* generic hardware linkage */
69 .flags = HCD_MEMORY | HCD_USB2,
71 /* basic lifecycle operations */
72 .reset = ehci_spear_setup,
75 .shutdown = ehci_shutdown,
77 /* managing i/o requests and associated device resources */
78 .urb_enqueue = ehci_urb_enqueue,
79 .urb_dequeue = ehci_urb_dequeue,
80 .endpoint_disable = ehci_endpoint_disable,
81 .endpoint_reset = ehci_endpoint_reset,
83 /* scheduling support */
84 .get_frame_number = ehci_get_frame,
86 /* root hub support */
87 .hub_status_data = ehci_hub_status_data,
88 .hub_control = ehci_hub_control,
89 .bus_suspend = ehci_bus_suspend,
90 .bus_resume = ehci_bus_resume,
91 .relinquish_port = ehci_relinquish_port,
92 .port_handed_over = ehci_port_handed_over,
93 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
97 static int ehci_spear_drv_suspend(struct device *dev)
99 struct usb_hcd *hcd = dev_get_drvdata(dev);
100 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
104 if (time_before(jiffies, ehci->next_statechange))
108 * Root hub was already suspended. Disable irq emission and mark HW
109 * unaccessible. The PM and USB cores make sure that the root hub is
110 * either suspended or stopped.
112 spin_lock_irqsave(&ehci->lock, flags);
113 ehci_prepare_ports_for_controller_suspend(ehci, device_may_wakeup(dev));
114 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
115 ehci_readl(ehci, &ehci->regs->intr_enable);
116 spin_unlock_irqrestore(&ehci->lock, flags);
121 static int ehci_spear_drv_resume(struct device *dev)
123 struct usb_hcd *hcd = dev_get_drvdata(dev);
124 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
126 if (time_before(jiffies, ehci->next_statechange))
129 if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF) {
130 int mask = INTR_MASK;
132 ehci_prepare_ports_for_controller_resume(ehci);
134 if (!hcd->self.root_hub->do_remote_wakeup)
137 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
138 ehci_readl(ehci, &ehci->regs->intr_enable);
142 usb_root_hub_lost_power(hcd->self.root_hub);
145 * Else reset, to cope with power loss or flush-to-storage style
146 * "resume" having let BIOS kick in during reboot.
151 /* emptying the schedule aborts any urbs */
152 spin_lock_irq(&ehci->lock);
154 end_unlink_async(ehci);
157 spin_unlock_irq(&ehci->lock);
159 ehci_writel(ehci, ehci->command, &ehci->regs->command);
160 ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
161 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
163 /* here we "know" root ports should always stay powered */
164 ehci_port_power(ehci, 1);
167 #endif /* CONFIG_PM */
169 static SIMPLE_DEV_PM_OPS(ehci_spear_pm_ops, ehci_spear_drv_suspend,
170 ehci_spear_drv_resume);
172 static u64 spear_ehci_dma_mask = DMA_BIT_MASK(32);
174 static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
176 struct usb_hcd *hcd ;
177 struct spear_ehci *ehci;
178 struct resource *res;
179 struct clk *usbh_clk;
180 const struct hc_driver *driver = &ehci_spear_hc_driver;
182 char clk_name[20] = "usbh_clk";
183 static int instance = -1;
188 irq = platform_get_irq(pdev, 0);
195 * Right now device-tree probed devices don't get dma_mask set.
196 * Since shared usb code relies on it, set it here for now.
197 * Once we have dma capability bindings this can go away.
199 if (!pdev->dev.dma_mask)
200 pdev->dev.dma_mask = &spear_ehci_dma_mask;
203 * Increment the device instance, when probing via device-tree
209 sprintf(clk_name, "usbh.%01d_clk", instance);
211 usbh_clk = clk_get(NULL, clk_name);
212 if (IS_ERR(usbh_clk)) {
213 dev_err(&pdev->dev, "Error getting interface clock\n");
214 retval = PTR_ERR(usbh_clk);
215 goto fail_get_usbh_clk;
218 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
221 goto fail_create_hcd;
224 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
227 goto fail_request_resource;
230 hcd->rsrc_start = res->start;
231 hcd->rsrc_len = resource_size(res);
232 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
233 driver->description)) {
235 goto fail_request_resource;
238 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
239 if (hcd->regs == NULL) {
240 dev_dbg(&pdev->dev, "error mapping memory\n");
245 ehci = (struct spear_ehci *)hcd_to_ehci(hcd);
246 ehci->clk = usbh_clk;
248 spear_start_ehci(ehci);
249 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
256 spear_stop_ehci(ehci);
259 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
260 fail_request_resource:
266 dev_err(&pdev->dev, "init fail, %d\n", retval);
271 static int spear_ehci_hcd_drv_remove(struct platform_device *pdev)
273 struct usb_hcd *hcd = platform_get_drvdata(pdev);
274 struct spear_ehci *ehci_p = to_spear_ehci(hcd);
283 spear_stop_ehci(ehci_p);
285 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
289 clk_put(ehci_p->clk);
294 static struct of_device_id spear_ehci_id_table[] __devinitdata = {
295 { .compatible = "st,spear600-ehci", },
299 static struct platform_driver spear_ehci_hcd_driver = {
300 .probe = spear_ehci_hcd_drv_probe,
301 .remove = spear_ehci_hcd_drv_remove,
302 .shutdown = usb_hcd_platform_shutdown,
304 .name = "spear-ehci",
305 .bus = &platform_bus_type,
306 .pm = &ehci_spear_pm_ops,
307 .of_match_table = of_match_ptr(spear_ehci_id_table),
311 MODULE_ALIAS("platform:spear-ehci");