ehci-omap.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. /*
  2. * ehci-omap.c - driver for USBHOST on OMAP3/4 processors
  3. *
  4. * Bus Glue for the EHCI controllers in OMAP3/4
  5. * Tested on several OMAP3 boards, and OMAP4 Pandaboard
  6. *
  7. * Copyright (C) 2007-2011 Texas Instruments, Inc.
  8. * Author: Vikram Pandita <vikram.pandita@ti.com>
  9. * Author: Anand Gadiyar <gadiyar@ti.com>
  10. * Author: Keshava Munegowda <keshava_mgowda@ti.com>
  11. *
  12. * Copyright (C) 2009 Nokia Corporation
  13. * Contact: Felipe Balbi <felipe.balbi@nokia.com>
  14. *
  15. * Based on "ehci-fsl.c" and "ehci-au1xxx.c" ehci glue layers
  16. *
  17. * This program is free software; you can redistribute it and/or modify
  18. * it under the terms of the GNU General Public License as published by
  19. * the Free Software Foundation; either version 2 of the License, or
  20. * (at your option) any later version.
  21. *
  22. * This program is distributed in the hope that it will be useful,
  23. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  25. * GNU General Public License for more details.
  26. *
  27. * You should have received a copy of the GNU General Public License
  28. * along with this program; if not, write to the Free Software
  29. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  30. *
  31. * TODO (last updated Feb 27, 2010):
  32. * - add kernel-doc
  33. * - enable AUTOIDLE
  34. * - add suspend/resume
  35. * - add HSIC and TLL support
  36. * - convert to use hwmod and runtime PM
  37. */
  38. #include <linux/platform_device.h>
  39. #include <linux/slab.h>
  40. #include <linux/usb/ulpi.h>
  41. #include <plat/usb.h>
  42. #include <linux/regulator/consumer.h>
  43. #include <linux/pm_runtime.h>
  44. #include <linux/gpio.h>
  45. /* EHCI Register Set */
  46. #define EHCI_INSNREG04 (0xA0)
  47. #define EHCI_INSNREG04_DISABLE_UNSUSPEND (1 << 5)
  48. #define EHCI_INSNREG05_ULPI (0xA4)
  49. #define EHCI_INSNREG05_ULPI_CONTROL_SHIFT 31
  50. #define EHCI_INSNREG05_ULPI_PORTSEL_SHIFT 24
  51. #define EHCI_INSNREG05_ULPI_OPSEL_SHIFT 22
  52. #define EHCI_INSNREG05_ULPI_REGADD_SHIFT 16
  53. #define EHCI_INSNREG05_ULPI_EXTREGADD_SHIFT 8
  54. #define EHCI_INSNREG05_ULPI_WRDATA_SHIFT 0
  55. /*-------------------------------------------------------------------------*/
  56. static const struct hc_driver ehci_omap_hc_driver;
  57. static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
  58. {
  59. __raw_writel(val, base + reg);
  60. }
  61. static inline u32 ehci_read(void __iomem *base, u32 reg)
  62. {
  63. return __raw_readl(base + reg);
  64. }
  65. static void omap_ehci_soft_phy_reset(struct platform_device *pdev, u8 port)
  66. {
  67. struct usb_hcd *hcd = dev_get_drvdata(&pdev->dev);
  68. unsigned long timeout = jiffies + msecs_to_jiffies(1000);
  69. unsigned reg = 0;
  70. reg = ULPI_FUNC_CTRL_RESET
  71. /* FUNCTION_CTRL_SET register */
  72. | (ULPI_SET(ULPI_FUNC_CTRL) << EHCI_INSNREG05_ULPI_REGADD_SHIFT)
  73. /* Write */
  74. | (2 << EHCI_INSNREG05_ULPI_OPSEL_SHIFT)
  75. /* PORTn */
  76. | ((port + 1) << EHCI_INSNREG05_ULPI_PORTSEL_SHIFT)
  77. /* start ULPI access*/
  78. | (1 << EHCI_INSNREG05_ULPI_CONTROL_SHIFT);
  79. ehci_write(hcd->regs, EHCI_INSNREG05_ULPI, reg);
  80. /* Wait for ULPI access completion */
  81. while ((ehci_read(hcd->regs, EHCI_INSNREG05_ULPI)
  82. & (1 << EHCI_INSNREG05_ULPI_CONTROL_SHIFT))) {
  83. cpu_relax();
  84. if (time_after(jiffies, timeout)) {
  85. dev_dbg(&pdev->dev, "phy reset operation timed out\n");
  86. break;
  87. }
  88. }
  89. }
  90. static void disable_put_regulator(
  91. struct ehci_hcd_omap_platform_data *pdata)
  92. {
  93. int i;
  94. for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
  95. if (pdata->regulator[i]) {
  96. regulator_disable(pdata->regulator[i]);
  97. regulator_put(pdata->regulator[i]);
  98. }
  99. }
  100. }
  101. /* configure so an HC device and id are always provided */
  102. /* always called with process context; sleeping is OK */
  103. /**
  104. * ehci_hcd_omap_probe - initialize TI-based HCDs
  105. *
  106. * Allocates basic resources for this USB host controller, and
  107. * then invokes the start() method for the HCD associated with it
  108. * through the hotplug entry's driver_data.
  109. */
  110. static int ehci_hcd_omap_probe(struct platform_device *pdev)
  111. {
  112. struct device *dev = &pdev->dev;
  113. struct ehci_hcd_omap_platform_data *pdata = dev->platform_data;
  114. struct resource *res;
  115. struct usb_hcd *hcd;
  116. void __iomem *regs;
  117. struct ehci_hcd *omap_ehci;
  118. int ret = -ENODEV;
  119. int irq;
  120. int i;
  121. char supply[7];
  122. if (usb_disabled())
  123. return -ENODEV;
  124. if (!dev->parent) {
  125. dev_err(dev, "Missing parent device\n");
  126. return -ENODEV;
  127. }
  128. irq = platform_get_irq_byname(pdev, "ehci-irq");
  129. if (irq < 0) {
  130. dev_err(dev, "EHCI irq failed\n");
  131. return -ENODEV;
  132. }
  133. res = platform_get_resource_byname(pdev,
  134. IORESOURCE_MEM, "ehci");
  135. if (!res) {
  136. dev_err(dev, "UHH EHCI get resource failed\n");
  137. return -ENODEV;
  138. }
  139. regs = ioremap(res->start, resource_size(res));
  140. if (!regs) {
  141. dev_err(dev, "UHH EHCI ioremap failed\n");
  142. return -ENOMEM;
  143. }
  144. hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
  145. dev_name(dev));
  146. if (!hcd) {
  147. dev_err(dev, "failed to create hcd with err %d\n", ret);
  148. ret = -ENOMEM;
  149. goto err_io;
  150. }
  151. hcd->rsrc_start = res->start;
  152. hcd->rsrc_len = resource_size(res);
  153. hcd->regs = regs;
  154. /* get ehci regulator and enable */
  155. for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
  156. if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY) {
  157. pdata->regulator[i] = NULL;
  158. continue;
  159. }
  160. snprintf(supply, sizeof(supply), "hsusb%d", i);
  161. pdata->regulator[i] = regulator_get(dev, supply);
  162. if (IS_ERR(pdata->regulator[i])) {
  163. pdata->regulator[i] = NULL;
  164. dev_dbg(dev,
  165. "failed to get ehci port%d regulator\n", i);
  166. } else {
  167. regulator_enable(pdata->regulator[i]);
  168. }
  169. }
  170. if (pdata->phy_reset) {
  171. if (gpio_is_valid(pdata->reset_gpio_port[0]))
  172. gpio_request_one(pdata->reset_gpio_port[0],
  173. GPIOF_OUT_INIT_LOW, "USB1 PHY reset");
  174. if (gpio_is_valid(pdata->reset_gpio_port[1]))
  175. gpio_request_one(pdata->reset_gpio_port[1],
  176. GPIOF_OUT_INIT_LOW, "USB2 PHY reset");
  177. /* Hold the PHY in RESET for enough time till DIR is high */
  178. udelay(10);
  179. }
  180. pm_runtime_enable(dev);
  181. pm_runtime_get_sync(dev);
  182. /*
  183. * An undocumented "feature" in the OMAP3 EHCI controller,
  184. * causes suspended ports to be taken out of suspend when
  185. * the USBCMD.Run/Stop bit is cleared (for example when
  186. * we do ehci_bus_suspend).
  187. * This breaks suspend-resume if the root-hub is allowed
  188. * to suspend. Writing 1 to this undocumented register bit
  189. * disables this feature and restores normal behavior.
  190. */
  191. ehci_write(regs, EHCI_INSNREG04,
  192. EHCI_INSNREG04_DISABLE_UNSUSPEND);
  193. /* Soft reset the PHY using PHY reset command over ULPI */
  194. if (pdata->port_mode[0] == OMAP_EHCI_PORT_MODE_PHY)
  195. omap_ehci_soft_phy_reset(pdev, 0);
  196. if (pdata->port_mode[1] == OMAP_EHCI_PORT_MODE_PHY)
  197. omap_ehci_soft_phy_reset(pdev, 1);
  198. omap_ehci = hcd_to_ehci(hcd);
  199. omap_ehci->sbrn = 0x20;
  200. /* we know this is the memory we want, no need to ioremap again */
  201. omap_ehci->caps = hcd->regs;
  202. omap_ehci->regs = hcd->regs
  203. + HC_LENGTH(ehci, readl(&omap_ehci->caps->hc_capbase));
  204. dbg_hcs_params(omap_ehci, "reset");
  205. dbg_hcc_params(omap_ehci, "reset");
  206. /* cache this readonly data; minimize chip reads */
  207. omap_ehci->hcs_params = readl(&omap_ehci->caps->hcs_params);
  208. ehci_reset(omap_ehci);
  209. if (pdata->phy_reset) {
  210. /* Hold the PHY in RESET for enough time till
  211. * PHY is settled and ready
  212. */
  213. udelay(10);
  214. if (gpio_is_valid(pdata->reset_gpio_port[0]))
  215. gpio_set_value_cansleep(pdata->reset_gpio_port[0], 1);
  216. if (gpio_is_valid(pdata->reset_gpio_port[1]))
  217. gpio_set_value_cansleep(pdata->reset_gpio_port[1], 1);
  218. }
  219. ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
  220. if (ret) {
  221. dev_err(dev, "failed to add hcd with err %d\n", ret);
  222. goto err_add_hcd;
  223. }
  224. /* root ports should always stay powered */
  225. ehci_port_power(omap_ehci, 1);
  226. return 0;
  227. err_add_hcd:
  228. disable_put_regulator(pdata);
  229. pm_runtime_put_sync(dev);
  230. err_io:
  231. iounmap(regs);
  232. return ret;
  233. }
  234. /**
  235. * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
  236. * @pdev: USB Host Controller being removed
  237. *
  238. * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
  239. * the HCD's stop() method. It is always called from a thread
  240. * context, normally "rmmod", "apmd", or something similar.
  241. */
  242. static int ehci_hcd_omap_remove(struct platform_device *pdev)
  243. {
  244. struct device *dev = &pdev->dev;
  245. struct usb_hcd *hcd = dev_get_drvdata(dev);
  246. struct ehci_hcd_omap_platform_data *pdata = dev->platform_data;
  247. usb_remove_hcd(hcd);
  248. disable_put_regulator(dev->platform_data);
  249. iounmap(hcd->regs);
  250. usb_put_hcd(hcd);
  251. pm_runtime_put_sync(dev);
  252. pm_runtime_disable(dev);
  253. if (pdata->phy_reset) {
  254. if (gpio_is_valid(pdata->reset_gpio_port[0]))
  255. gpio_free(pdata->reset_gpio_port[0]);
  256. if (gpio_is_valid(pdata->reset_gpio_port[1]))
  257. gpio_free(pdata->reset_gpio_port[1]);
  258. }
  259. return 0;
  260. }
  261. static void ehci_hcd_omap_shutdown(struct platform_device *pdev)
  262. {
  263. struct usb_hcd *hcd = dev_get_drvdata(&pdev->dev);
  264. if (hcd->driver->shutdown)
  265. hcd->driver->shutdown(hcd);
  266. }
  267. static struct platform_driver ehci_hcd_omap_driver = {
  268. .probe = ehci_hcd_omap_probe,
  269. .remove = ehci_hcd_omap_remove,
  270. .shutdown = ehci_hcd_omap_shutdown,
  271. /*.suspend = ehci_hcd_omap_suspend, */
  272. /*.resume = ehci_hcd_omap_resume, */
  273. .driver = {
  274. .name = "ehci-omap",
  275. }
  276. };
  277. /*-------------------------------------------------------------------------*/
  278. static const struct hc_driver ehci_omap_hc_driver = {
  279. .description = hcd_name,
  280. .product_desc = "OMAP-EHCI Host Controller",
  281. .hcd_priv_size = sizeof(struct ehci_hcd),
  282. /*
  283. * generic hardware linkage
  284. */
  285. .irq = ehci_irq,
  286. .flags = HCD_MEMORY | HCD_USB2,
  287. /*
  288. * basic lifecycle operations
  289. */
  290. .reset = ehci_init,
  291. .start = ehci_run,
  292. .stop = ehci_stop,
  293. .shutdown = ehci_shutdown,
  294. /*
  295. * managing i/o requests and associated device resources
  296. */
  297. .urb_enqueue = ehci_urb_enqueue,
  298. .urb_dequeue = ehci_urb_dequeue,
  299. .endpoint_disable = ehci_endpoint_disable,
  300. .endpoint_reset = ehci_endpoint_reset,
  301. /*
  302. * scheduling support
  303. */
  304. .get_frame_number = ehci_get_frame,
  305. /*
  306. * root hub support
  307. */
  308. .hub_status_data = ehci_hub_status_data,
  309. .hub_control = ehci_hub_control,
  310. .bus_suspend = ehci_bus_suspend,
  311. .bus_resume = ehci_bus_resume,
  312. .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
  313. };
  314. MODULE_ALIAS("platform:omap-ehci");
  315. MODULE_AUTHOR("Texas Instruments, Inc.");
  316. MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");