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 retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)); 60 if (retval) 61 goto fail; 62 63 usbh_clk = devm_clk_get(&pdev->dev, NULL); 64 if (IS_ERR(usbh_clk)) { 65 dev_err(&pdev->dev, "Error getting interface clock\n"); 66 retval = PTR_ERR(usbh_clk); 67 goto fail; 68 } 69 70 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev)); 71 if (!hcd) { 72 retval = -ENOMEM; 73 goto fail; 74 } 75 76 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 77 if (!res) { 78 retval = -ENODEV; 79 goto err_put_hcd; 80 } 81 82 hcd->rsrc_start = pdev->resource[0].start; 83 hcd->rsrc_len = resource_size(res); 84 if (!devm_request_mem_region(&pdev->dev, hcd->rsrc_start, hcd->rsrc_len, 85 hcd_name)) { 86 dev_dbg(&pdev->dev, "request_mem_region failed\n"); 87 retval = -EBUSY; 88 goto err_put_hcd; 89 } 90 91 hcd->regs = devm_ioremap(&pdev->dev, hcd->rsrc_start, hcd->rsrc_len); 92 if (!hcd->regs) { 93 dev_dbg(&pdev->dev, "ioremap failed\n"); 94 retval = -ENOMEM; 95 goto err_put_hcd; 96 } 97 98 sohci_p = to_spear_ohci(hcd); 99 sohci_p->clk = usbh_clk; 100 101 clk_prepare_enable(sohci_p->clk); 102 103 ohci = hcd_to_ohci(hcd); 104 105 retval = usb_add_hcd(hcd, platform_get_irq(pdev, 0), 0); 106 if (retval == 0) { 107 device_wakeup_enable(hcd->self.controller); 108 return retval; 109 } 110 111 clk_disable_unprepare(sohci_p->clk); 112 err_put_hcd: 113 usb_put_hcd(hcd); 114 fail: 115 dev_err(&pdev->dev, "init fail, %d\n", retval); 116 117 return retval; 118 } 119 120 static int spear_ohci_hcd_drv_remove(struct platform_device *pdev) 121 { 122 struct usb_hcd *hcd = platform_get_drvdata(pdev); 123 struct spear_ohci *sohci_p = to_spear_ohci(hcd); 124 125 usb_remove_hcd(hcd); 126 if (sohci_p->clk) 127 clk_disable_unprepare(sohci_p->clk); 128 129 usb_put_hcd(hcd); 130 return 0; 131 } 132 133 #if defined(CONFIG_PM) 134 static int spear_ohci_hcd_drv_suspend(struct platform_device *pdev, 135 pm_message_t message) 136 { 137 struct usb_hcd *hcd = platform_get_drvdata(pdev); 138 struct ohci_hcd *ohci = hcd_to_ohci(hcd); 139 struct spear_ohci *sohci_p = to_spear_ohci(hcd); 140 bool do_wakeup = device_may_wakeup(&pdev->dev); 141 int ret; 142 143 if (time_before(jiffies, ohci->next_statechange)) 144 msleep(5); 145 ohci->next_statechange = jiffies; 146 147 ret = ohci_suspend(hcd, do_wakeup); 148 if (ret) 149 return ret; 150 151 clk_disable_unprepare(sohci_p->clk); 152 153 return ret; 154 } 155 156 static int spear_ohci_hcd_drv_resume(struct platform_device *dev) 157 { 158 struct usb_hcd *hcd = platform_get_drvdata(dev); 159 struct ohci_hcd *ohci = hcd_to_ohci(hcd); 160 struct spear_ohci *sohci_p = to_spear_ohci(hcd); 161 162 if (time_before(jiffies, ohci->next_statechange)) 163 msleep(5); 164 ohci->next_statechange = jiffies; 165 166 clk_prepare_enable(sohci_p->clk); 167 ohci_resume(hcd, false); 168 return 0; 169 } 170 #endif 171 172 static struct of_device_id spear_ohci_id_table[] = { 173 { .compatible = "st,spear600-ohci", }, 174 { }, 175 }; 176 177 /* Driver definition to register with the platform bus */ 178 static struct platform_driver spear_ohci_hcd_driver = { 179 .probe = spear_ohci_hcd_drv_probe, 180 .remove = spear_ohci_hcd_drv_remove, 181 #ifdef CONFIG_PM 182 .suspend = spear_ohci_hcd_drv_suspend, 183 .resume = spear_ohci_hcd_drv_resume, 184 #endif 185 .driver = { 186 .owner = THIS_MODULE, 187 .name = "spear-ohci", 188 .of_match_table = spear_ohci_id_table, 189 }, 190 }; 191 192 static const struct ohci_driver_overrides spear_overrides __initconst = { 193 .extra_priv_size = sizeof(struct spear_ohci), 194 }; 195 static int __init ohci_spear_init(void) 196 { 197 if (usb_disabled()) 198 return -ENODEV; 199 200 pr_info("%s: " DRIVER_DESC "\n", hcd_name); 201 202 ohci_init_driver(&ohci_spear_hc_driver, &spear_overrides); 203 return platform_driver_register(&spear_ohci_hcd_driver); 204 } 205 module_init(ohci_spear_init); 206 207 static void __exit ohci_spear_cleanup(void) 208 { 209 platform_driver_unregister(&spear_ohci_hcd_driver); 210 } 211 module_exit(ohci_spear_cleanup); 212 213 MODULE_DESCRIPTION(DRIVER_DESC); 214 MODULE_AUTHOR("Deepak Sikri"); 215 MODULE_LICENSE("GPL v2"); 216 MODULE_ALIAS("platform:spear-ohci"); 217