1 /* 2 * SAMSUNG EXYNOS USB HOST OHCI Controller 3 * 4 * Copyright (C) 2011 Samsung Electronics Co.Ltd 5 * Author: Jingoo Han <jg1.han@samsung.com> 6 * 7 * This program is free software; you can redistribute it and/or modify it 8 * under the terms of the GNU General Public License as published by the 9 * Free Software Foundation; either version 2 of the License, or (at your 10 * option) any later version. 11 * 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/usb/phy.h> 22 #include <linux/usb/samsung_usb_phy.h> 23 #include <linux/usb.h> 24 #include <linux/usb/hcd.h> 25 #include <linux/usb/otg.h> 26 27 #include "ohci.h" 28 29 #define DRIVER_DESC "OHCI EXYNOS driver" 30 31 static const char hcd_name[] = "ohci-exynos"; 32 static struct hc_driver __read_mostly exynos_ohci_hc_driver; 33 34 #define to_exynos_ohci(hcd) (struct exynos_ohci_hcd *)(hcd_to_ohci(hcd)->priv) 35 36 struct exynos_ohci_hcd { 37 struct clk *clk; 38 struct usb_phy *phy; 39 struct usb_otg *otg; 40 }; 41 42 static void exynos_ohci_phy_enable(struct platform_device *pdev) 43 { 44 struct usb_hcd *hcd = platform_get_drvdata(pdev); 45 struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd); 46 47 if (exynos_ohci->phy) 48 usb_phy_init(exynos_ohci->phy); 49 } 50 51 static void exynos_ohci_phy_disable(struct platform_device *pdev) 52 { 53 struct usb_hcd *hcd = platform_get_drvdata(pdev); 54 struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd); 55 56 if (exynos_ohci->phy) 57 usb_phy_shutdown(exynos_ohci->phy); 58 } 59 60 static int exynos_ohci_probe(struct platform_device *pdev) 61 { 62 struct exynos_ohci_hcd *exynos_ohci; 63 struct usb_hcd *hcd; 64 struct resource *res; 65 struct usb_phy *phy; 66 int irq; 67 int err; 68 69 /* 70 * Right now device-tree probed devices don't get dma_mask set. 71 * Since shared usb code relies on it, set it here for now. 72 * Once we move to full device tree support this will vanish off. 73 */ 74 err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)); 75 if (err) 76 return err; 77 78 hcd = usb_create_hcd(&exynos_ohci_hc_driver, 79 &pdev->dev, dev_name(&pdev->dev)); 80 if (!hcd) { 81 dev_err(&pdev->dev, "Unable to create HCD\n"); 82 return -ENOMEM; 83 } 84 85 exynos_ohci = to_exynos_ohci(hcd); 86 87 if (of_device_is_compatible(pdev->dev.of_node, 88 "samsung,exynos5440-ohci")) 89 goto skip_phy; 90 91 phy = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2); 92 if (IS_ERR(phy)) { 93 usb_put_hcd(hcd); 94 dev_warn(&pdev->dev, "no platform data or transceiver defined\n"); 95 return -EPROBE_DEFER; 96 } else { 97 exynos_ohci->phy = phy; 98 exynos_ohci->otg = phy->otg; 99 } 100 101 skip_phy: 102 exynos_ohci->clk = devm_clk_get(&pdev->dev, "usbhost"); 103 104 if (IS_ERR(exynos_ohci->clk)) { 105 dev_err(&pdev->dev, "Failed to get usbhost clock\n"); 106 err = PTR_ERR(exynos_ohci->clk); 107 goto fail_clk; 108 } 109 110 err = clk_prepare_enable(exynos_ohci->clk); 111 if (err) 112 goto fail_clk; 113 114 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 115 if (!res) { 116 dev_err(&pdev->dev, "Failed to get I/O memory\n"); 117 err = -ENXIO; 118 goto fail_io; 119 } 120 121 hcd->rsrc_start = res->start; 122 hcd->rsrc_len = resource_size(res); 123 hcd->regs = devm_ioremap(&pdev->dev, res->start, hcd->rsrc_len); 124 if (!hcd->regs) { 125 dev_err(&pdev->dev, "Failed to remap I/O memory\n"); 126 err = -ENOMEM; 127 goto fail_io; 128 } 129 130 irq = platform_get_irq(pdev, 0); 131 if (!irq) { 132 dev_err(&pdev->dev, "Failed to get IRQ\n"); 133 err = -ENODEV; 134 goto fail_io; 135 } 136 137 if (exynos_ohci->otg) 138 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self); 139 140 platform_set_drvdata(pdev, hcd); 141 142 exynos_ohci_phy_enable(pdev); 143 144 err = usb_add_hcd(hcd, irq, IRQF_SHARED); 145 if (err) { 146 dev_err(&pdev->dev, "Failed to add USB HCD\n"); 147 goto fail_add_hcd; 148 } 149 return 0; 150 151 fail_add_hcd: 152 exynos_ohci_phy_disable(pdev); 153 fail_io: 154 clk_disable_unprepare(exynos_ohci->clk); 155 fail_clk: 156 usb_put_hcd(hcd); 157 return err; 158 } 159 160 static int exynos_ohci_remove(struct platform_device *pdev) 161 { 162 struct usb_hcd *hcd = platform_get_drvdata(pdev); 163 struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd); 164 165 usb_remove_hcd(hcd); 166 167 if (exynos_ohci->otg) 168 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self); 169 170 exynos_ohci_phy_disable(pdev); 171 172 clk_disable_unprepare(exynos_ohci->clk); 173 174 usb_put_hcd(hcd); 175 176 return 0; 177 } 178 179 static void exynos_ohci_shutdown(struct platform_device *pdev) 180 { 181 struct usb_hcd *hcd = platform_get_drvdata(pdev); 182 183 if (hcd->driver->shutdown) 184 hcd->driver->shutdown(hcd); 185 } 186 187 #ifdef CONFIG_PM 188 static int exynos_ohci_suspend(struct device *dev) 189 { 190 struct usb_hcd *hcd = dev_get_drvdata(dev); 191 struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd); 192 struct ohci_hcd *ohci = hcd_to_ohci(hcd); 193 struct platform_device *pdev = to_platform_device(dev); 194 unsigned long flags; 195 int rc = 0; 196 197 /* 198 * Root hub was already suspended. Disable irq emission and 199 * mark HW unaccessible, bail out if RH has been resumed. Use 200 * the spinlock to properly synchronize with possible pending 201 * RH suspend or resume activity. 202 */ 203 spin_lock_irqsave(&ohci->lock, flags); 204 if (ohci->rh_state != OHCI_RH_SUSPENDED && 205 ohci->rh_state != OHCI_RH_HALTED) { 206 rc = -EINVAL; 207 goto fail; 208 } 209 210 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); 211 212 if (exynos_ohci->otg) 213 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self); 214 215 exynos_ohci_phy_disable(pdev); 216 217 clk_disable_unprepare(exynos_ohci->clk); 218 219 fail: 220 spin_unlock_irqrestore(&ohci->lock, flags); 221 222 return rc; 223 } 224 225 static int exynos_ohci_resume(struct device *dev) 226 { 227 struct usb_hcd *hcd = dev_get_drvdata(dev); 228 struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd); 229 struct platform_device *pdev = to_platform_device(dev); 230 231 clk_prepare_enable(exynos_ohci->clk); 232 233 if (exynos_ohci->otg) 234 exynos_ohci->otg->set_host(exynos_ohci->otg, &hcd->self); 235 236 exynos_ohci_phy_enable(pdev); 237 238 ohci_resume(hcd, false); 239 240 return 0; 241 } 242 #else 243 #define exynos_ohci_suspend NULL 244 #define exynos_ohci_resume NULL 245 #endif 246 247 static const struct ohci_driver_overrides exynos_overrides __initconst = { 248 .extra_priv_size = sizeof(struct exynos_ohci_hcd), 249 }; 250 251 static const struct dev_pm_ops exynos_ohci_pm_ops = { 252 .suspend = exynos_ohci_suspend, 253 .resume = exynos_ohci_resume, 254 }; 255 256 #ifdef CONFIG_OF 257 static const struct of_device_id exynos_ohci_match[] = { 258 { .compatible = "samsung,exynos4210-ohci" }, 259 { .compatible = "samsung,exynos5440-ohci" }, 260 {}, 261 }; 262 MODULE_DEVICE_TABLE(of, exynos_ohci_match); 263 #endif 264 265 static struct platform_driver exynos_ohci_driver = { 266 .probe = exynos_ohci_probe, 267 .remove = exynos_ohci_remove, 268 .shutdown = exynos_ohci_shutdown, 269 .driver = { 270 .name = "exynos-ohci", 271 .owner = THIS_MODULE, 272 .pm = &exynos_ohci_pm_ops, 273 .of_match_table = of_match_ptr(exynos_ohci_match), 274 } 275 }; 276 static int __init ohci_exynos_init(void) 277 { 278 if (usb_disabled()) 279 return -ENODEV; 280 281 pr_info("%s: " DRIVER_DESC "\n", hcd_name); 282 ohci_init_driver(&exynos_ohci_hc_driver, &exynos_overrides); 283 return platform_driver_register(&exynos_ohci_driver); 284 } 285 module_init(ohci_exynos_init); 286 287 static void __exit ohci_exynos_cleanup(void) 288 { 289 platform_driver_unregister(&exynos_ohci_driver); 290 } 291 module_exit(ohci_exynos_cleanup); 292 293 MODULE_ALIAS("platform:exynos-ohci"); 294 MODULE_AUTHOR("Jingoo Han <jg1.han@samsung.com>"); 295 MODULE_LICENSE("GPL v2"); 296