2 * Copyright 2005-2009 MontaVista Software, Inc.
3 * Copyright 2008,2012 Freescale Semiconductor, Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 * Ported to 834x by Randy Vinson <rvinson@mvista.com> using code provided
21 * Power Management support by Dave Liu <daveliu@freescale.com>,
22 * Jerry Huang <Chang-Ming.Huang@freescale.com> and
23 * Anton Vorontsov <avorontsov@ru.mvista.com>.
26 #include <linux/kernel.h>
27 #include <linux/types.h>
28 #include <linux/delay.h>
30 #include <linux/platform_device.h>
31 #include <linux/fsl_devices.h>
35 /* configure so an HC device and id are always provided */
36 /* always called with process context; sleeping is OK */
39 * usb_hcd_fsl_probe - initialize FSL-based HCDs
40 * @drvier: Driver to be used for this HCD
41 * @pdev: USB Host Controller being probed
42 * Context: !in_interrupt()
44 * Allocates basic resources for this USB host controller.
47 static int usb_hcd_fsl_probe(const struct hc_driver *driver,
48 struct platform_device *pdev)
50 struct fsl_usb2_platform_data *pdata;
56 pr_debug("initializing FSL-SOC USB Controller\n");
58 /* Need platform data for setup */
59 pdata = (struct fsl_usb2_platform_data *)pdev->dev.platform_data;
62 "No platform data for %s.\n", dev_name(&pdev->dev));
67 * This is a host mode driver, verify that we're supposed to be
70 if (!((pdata->operating_mode == FSL_USB2_DR_HOST) ||
71 (pdata->operating_mode == FSL_USB2_MPH_HOST) ||
72 (pdata->operating_mode == FSL_USB2_DR_OTG))) {
74 "Non Host Mode configured for %s. Wrong driver linked.\n",
75 dev_name(&pdev->dev));
79 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
82 "Found HC with no IRQ. Check %s setup!\n",
83 dev_name(&pdev->dev));
88 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
94 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
97 "Found HC with no register addr. Check %s setup!\n",
98 dev_name(&pdev->dev));
102 hcd->rsrc_start = res->start;
103 hcd->rsrc_len = resource_size(res);
104 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
105 driver->description)) {
106 dev_dbg(&pdev->dev, "controller already in use\n");
110 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
112 if (hcd->regs == NULL) {
113 dev_dbg(&pdev->dev, "error mapping memory\n");
118 pdata->regs = hcd->regs;
120 if (pdata->power_budget)
121 hcd->power_budget = pdata->power_budget;
124 * do platform specific init: check the clock, grab/config pins, etc.
126 if (pdata->init && pdata->init(pdev)) {
131 /* Enable USB controller, 83xx or 8536 */
132 if (pdata->have_sysif_regs)
133 setbits32(hcd->regs + FSL_SOC_USB_CTRL, 0x4);
135 /* Don't need to set host mode here. It will be done by tdi_reset() */
137 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
141 #ifdef CONFIG_USB_OTG
142 if (pdata->operating_mode == FSL_USB2_DR_OTG) {
143 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
145 ehci->transceiver = usb_get_transceiver();
146 dev_dbg(&pdev->dev, "hcd=0x%p ehci=0x%p, transceiver=0x%p\n",
147 hcd, ehci, ehci->transceiver);
149 if (ehci->transceiver) {
150 retval = otg_set_host(ehci->transceiver->otg,
151 &ehci_to_hcd(ehci)->self);
153 if (ehci->transceiver)
154 put_device(ehci->transceiver->dev);
158 dev_err(&pdev->dev, "can't find transceiver\n");
169 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
173 dev_err(&pdev->dev, "init %s fail, %d\n", dev_name(&pdev->dev), retval);
179 /* may be called without controller electrically present */
180 /* may be called with controller, bus, and devices active */
183 * usb_hcd_fsl_remove - shutdown processing for FSL-based HCDs
184 * @dev: USB Host Controller being removed
185 * Context: !in_interrupt()
187 * Reverses the effect of usb_hcd_fsl_probe().
190 static void usb_hcd_fsl_remove(struct usb_hcd *hcd,
191 struct platform_device *pdev)
193 struct fsl_usb2_platform_data *pdata = pdev->dev.platform_data;
194 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
196 if (ehci->transceiver) {
197 otg_set_host(ehci->transceiver->otg, NULL);
198 put_device(ehci->transceiver->dev);
204 * do platform specific un-initialization:
205 * release iomux pins, disable clock, etc.
210 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
214 static void ehci_fsl_setup_phy(struct usb_hcd *hcd,
215 enum fsl_usb2_phy_modes phy_mode,
216 unsigned int port_offset)
219 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
220 void __iomem *non_ehci = hcd->regs;
221 struct device *dev = hcd->self.controller;
222 struct fsl_usb2_platform_data *pdata = dev->platform_data;
224 if (pdata->controller_ver < 0) {
225 dev_warn(hcd->self.controller, "Could not get controller version\n");
229 portsc = ehci_readl(ehci, &ehci->regs->port_status[port_offset]);
230 portsc &= ~(PORT_PTS_MSK | PORT_PTS_PTW);
233 case FSL_USB2_PHY_ULPI:
234 if (pdata->controller_ver) {
235 /* controller version 1.6 or above */
236 temp = in_be32(non_ehci + FSL_SOC_USB_CTRL);
237 out_be32(non_ehci + FSL_SOC_USB_CTRL, temp |
238 USB_CTRL_USB_EN | ULPI_PHY_CLK_SEL);
240 portsc |= PORT_PTS_ULPI;
242 case FSL_USB2_PHY_SERIAL:
243 portsc |= PORT_PTS_SERIAL;
245 case FSL_USB2_PHY_UTMI_WIDE:
246 portsc |= PORT_PTS_PTW;
248 case FSL_USB2_PHY_UTMI:
249 if (pdata->controller_ver) {
250 /* controller version 1.6 or above */
251 temp = in_be32(non_ehci + FSL_SOC_USB_CTRL);
252 out_be32(non_ehci + FSL_SOC_USB_CTRL, temp |
253 UTMI_PHY_EN | USB_CTRL_USB_EN);
254 mdelay(FSL_UTMI_PHY_DLY); /* Delay for UTMI PHY CLK to
255 become stable - 10ms*/
257 /* enable UTMI PHY */
258 if (pdata->have_sysif_regs)
259 setbits32(non_ehci + FSL_SOC_USB_CTRL,
261 portsc |= PORT_PTS_UTMI;
263 case FSL_USB2_PHY_NONE:
266 ehci_writel(ehci, portsc, &ehci->regs->port_status[port_offset]);
269 static void ehci_fsl_usb_setup(struct ehci_hcd *ehci)
271 struct usb_hcd *hcd = ehci_to_hcd(ehci);
272 struct fsl_usb2_platform_data *pdata;
273 void __iomem *non_ehci = hcd->regs;
276 pdata = hcd->self.controller->platform_data;
278 /* Enable PHY interface in the control reg. */
279 if (pdata->have_sysif_regs) {
280 temp = in_be32(non_ehci + FSL_SOC_USB_CTRL);
281 out_be32(non_ehci + FSL_SOC_USB_CTRL, temp | 0x00000004);
284 * Turn on cache snooping hardware, since some PowerPC platforms
285 * wholly rely on hardware to deal with cache coherent
288 /* Setup Snooping for all the 4GB space */
289 /* SNOOP1 starts from 0x0, size 2G */
290 out_be32(non_ehci + FSL_SOC_USB_SNOOP1, 0x0 | SNOOP_SIZE_2GB);
291 /* SNOOP2 starts from 0x80000000, size 2G */
292 out_be32(non_ehci + FSL_SOC_USB_SNOOP2, 0x80000000 | SNOOP_SIZE_2GB);
295 if ((pdata->operating_mode == FSL_USB2_DR_HOST) ||
296 (pdata->operating_mode == FSL_USB2_DR_OTG))
297 ehci_fsl_setup_phy(hcd, pdata->phy_mode, 0);
299 if (pdata->operating_mode == FSL_USB2_MPH_HOST) {
300 unsigned int chip, rev, svr;
302 svr = mfspr(SPRN_SVR);
304 rev = (svr >> 4) & 0xf;
306 /* Deal with USB Erratum #14 on MPC834x Rev 1.0 & 1.1 chips */
307 if ((rev == 1) && (chip >= 0x8050) && (chip <= 0x8055))
308 ehci->has_fsl_port_bug = 1;
310 if (pdata->port_enables & FSL_USB2_PORT0_ENABLED)
311 ehci_fsl_setup_phy(hcd, pdata->phy_mode, 0);
312 if (pdata->port_enables & FSL_USB2_PORT1_ENABLED)
313 ehci_fsl_setup_phy(hcd, pdata->phy_mode, 1);
316 if (pdata->have_sysif_regs) {
317 #ifdef CONFIG_PPC_85xx
318 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x00000008);
319 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000080);
321 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x0000000c);
322 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000040);
324 out_be32(non_ehci + FSL_SOC_USB_SICTRL, 0x00000001);
328 /* called after powerup, by probe or system-pm "wakeup" */
329 static int ehci_fsl_reinit(struct ehci_hcd *ehci)
331 ehci_fsl_usb_setup(ehci);
332 ehci_port_power(ehci, 0);
337 /* called during probe() after chip reset completes */
338 static int ehci_fsl_setup(struct usb_hcd *hcd)
340 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
342 struct fsl_usb2_platform_data *pdata;
345 dev = hcd->self.controller;
346 pdata = hcd->self.controller->platform_data;
347 ehci->big_endian_desc = pdata->big_endian_desc;
348 ehci->big_endian_mmio = pdata->big_endian_mmio;
350 /* EHCI registers start at offset 0x100 */
351 ehci->caps = hcd->regs + 0x100;
352 ehci->regs = hcd->regs + 0x100 +
353 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
354 dbg_hcs_params(ehci, "reset");
355 dbg_hcc_params(ehci, "reset");
357 /* cache this readonly data; minimize chip reads */
358 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
362 retval = ehci_halt(ehci);
366 /* data structure init */
367 retval = ehci_init(hcd);
375 if (of_device_is_compatible(dev->parent->of_node,
376 "fsl,mpc5121-usb2-dr")) {
378 * set SBUSCFG:AHBBRST so that control msgs don't
379 * fail when doing heavy PATA writes.
381 ehci_writel(ehci, SBUSCFG_INCR8,
382 hcd->regs + FSL_SOC_USB_SBUSCFG);
385 retval = ehci_fsl_reinit(ehci);
390 struct ehci_hcd ehci;
393 /* Saved USB PHY settings, need to restore after deep sleep. */
400 #ifdef CONFIG_PPC_MPC512x
401 static int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
403 struct usb_hcd *hcd = dev_get_drvdata(dev);
404 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
405 struct fsl_usb2_platform_data *pdata = dev->platform_data;
409 u32 mode = ehci_readl(ehci, hcd->regs + FSL_SOC_USB_USBMODE);
410 mode &= USBMODE_CM_MASK;
411 tmp = ehci_readl(ehci, hcd->regs + 0x140); /* usbcmd */
413 dev_dbg(dev, "suspend=%d already_suspended=%d "
414 "mode=%d usbcmd %08x\n", pdata->suspended,
415 pdata->already_suspended, mode, tmp);
419 * If the controller is already suspended, then this must be a
420 * PM suspend. Remember this fact, so that we will leave the
421 * controller suspended at PM resume time.
423 if (pdata->suspended) {
424 dev_dbg(dev, "already suspended, leaving early\n");
425 pdata->already_suspended = 1;
429 dev_dbg(dev, "suspending...\n");
431 ehci->rh_state = EHCI_RH_SUSPENDED;
432 dev->power.power_state = PMSG_SUSPEND;
434 /* ignore non-host interrupts */
435 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
437 /* stop the controller */
438 tmp = ehci_readl(ehci, &ehci->regs->command);
440 ehci_writel(ehci, tmp, &ehci->regs->command);
442 /* save EHCI registers */
443 pdata->pm_command = ehci_readl(ehci, &ehci->regs->command);
444 pdata->pm_command &= ~CMD_RUN;
445 pdata->pm_status = ehci_readl(ehci, &ehci->regs->status);
446 pdata->pm_intr_enable = ehci_readl(ehci, &ehci->regs->intr_enable);
447 pdata->pm_frame_index = ehci_readl(ehci, &ehci->regs->frame_index);
448 pdata->pm_segment = ehci_readl(ehci, &ehci->regs->segment);
449 pdata->pm_frame_list = ehci_readl(ehci, &ehci->regs->frame_list);
450 pdata->pm_async_next = ehci_readl(ehci, &ehci->regs->async_next);
451 pdata->pm_configured_flag =
452 ehci_readl(ehci, &ehci->regs->configured_flag);
453 pdata->pm_portsc = ehci_readl(ehci, &ehci->regs->port_status[0]);
454 pdata->pm_usbgenctrl = ehci_readl(ehci,
455 hcd->regs + FSL_SOC_USB_USBGENCTRL);
457 /* clear the W1C bits */
458 pdata->pm_portsc &= cpu_to_hc32(ehci, ~PORT_RWC_BITS);
460 pdata->suspended = 1;
462 /* clear PP to cut power to the port */
463 tmp = ehci_readl(ehci, &ehci->regs->port_status[0]);
465 ehci_writel(ehci, tmp, &ehci->regs->port_status[0]);
470 static int ehci_fsl_mpc512x_drv_resume(struct device *dev)
472 struct usb_hcd *hcd = dev_get_drvdata(dev);
473 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
474 struct fsl_usb2_platform_data *pdata = dev->platform_data;
477 dev_dbg(dev, "suspend=%d already_suspended=%d\n",
478 pdata->suspended, pdata->already_suspended);
481 * If the controller was already suspended at suspend time,
482 * then don't resume it now.
484 if (pdata->already_suspended) {
485 dev_dbg(dev, "already suspended, leaving early\n");
486 pdata->already_suspended = 0;
490 if (!pdata->suspended) {
491 dev_dbg(dev, "not suspended, leaving early\n");
495 pdata->suspended = 0;
497 dev_dbg(dev, "resuming...\n");
500 tmp = USBMODE_CM_HOST | (pdata->es ? USBMODE_ES : 0);
501 ehci_writel(ehci, tmp, hcd->regs + FSL_SOC_USB_USBMODE);
503 ehci_writel(ehci, pdata->pm_usbgenctrl,
504 hcd->regs + FSL_SOC_USB_USBGENCTRL);
505 ehci_writel(ehci, ISIPHYCTRL_PXE | ISIPHYCTRL_PHYE,
506 hcd->regs + FSL_SOC_USB_ISIPHYCTRL);
508 ehci_writel(ehci, SBUSCFG_INCR8, hcd->regs + FSL_SOC_USB_SBUSCFG);
510 /* restore EHCI registers */
511 ehci_writel(ehci, pdata->pm_command, &ehci->regs->command);
512 ehci_writel(ehci, pdata->pm_intr_enable, &ehci->regs->intr_enable);
513 ehci_writel(ehci, pdata->pm_frame_index, &ehci->regs->frame_index);
514 ehci_writel(ehci, pdata->pm_segment, &ehci->regs->segment);
515 ehci_writel(ehci, pdata->pm_frame_list, &ehci->regs->frame_list);
516 ehci_writel(ehci, pdata->pm_async_next, &ehci->regs->async_next);
517 ehci_writel(ehci, pdata->pm_configured_flag,
518 &ehci->regs->configured_flag);
519 ehci_writel(ehci, pdata->pm_portsc, &ehci->regs->port_status[0]);
521 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
522 ehci->rh_state = EHCI_RH_RUNNING;
523 dev->power.power_state = PMSG_ON;
525 tmp = ehci_readl(ehci, &ehci->regs->command);
527 ehci_writel(ehci, tmp, &ehci->regs->command);
529 usb_hcd_resume_root_hub(hcd);
534 static inline int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
539 static inline int ehci_fsl_mpc512x_drv_resume(struct device *dev)
543 #endif /* CONFIG_PPC_MPC512x */
545 static struct ehci_fsl *hcd_to_ehci_fsl(struct usb_hcd *hcd)
547 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
549 return container_of(ehci, struct ehci_fsl, ehci);
552 static int ehci_fsl_drv_suspend(struct device *dev)
554 struct usb_hcd *hcd = dev_get_drvdata(dev);
555 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
556 void __iomem *non_ehci = hcd->regs;
558 if (of_device_is_compatible(dev->parent->of_node,
559 "fsl,mpc5121-usb2-dr")) {
560 return ehci_fsl_mpc512x_drv_suspend(dev);
563 ehci_prepare_ports_for_controller_suspend(hcd_to_ehci(hcd),
564 device_may_wakeup(dev));
565 if (!fsl_deep_sleep())
568 ehci_fsl->usb_ctrl = in_be32(non_ehci + FSL_SOC_USB_CTRL);
572 static int ehci_fsl_drv_resume(struct device *dev)
574 struct usb_hcd *hcd = dev_get_drvdata(dev);
575 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
576 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
577 void __iomem *non_ehci = hcd->regs;
579 if (of_device_is_compatible(dev->parent->of_node,
580 "fsl,mpc5121-usb2-dr")) {
581 return ehci_fsl_mpc512x_drv_resume(dev);
584 ehci_prepare_ports_for_controller_resume(ehci);
585 if (!fsl_deep_sleep())
588 usb_root_hub_lost_power(hcd->self.root_hub);
590 /* Restore USB PHY settings and enable the controller. */
591 out_be32(non_ehci + FSL_SOC_USB_CTRL, ehci_fsl->usb_ctrl);
594 ehci_fsl_reinit(ehci);
599 static int ehci_fsl_drv_restore(struct device *dev)
601 struct usb_hcd *hcd = dev_get_drvdata(dev);
603 usb_root_hub_lost_power(hcd->self.root_hub);
607 static struct dev_pm_ops ehci_fsl_pm_ops = {
608 .suspend = ehci_fsl_drv_suspend,
609 .resume = ehci_fsl_drv_resume,
610 .restore = ehci_fsl_drv_restore,
613 #define EHCI_FSL_PM_OPS (&ehci_fsl_pm_ops)
615 #define EHCI_FSL_PM_OPS NULL
616 #endif /* CONFIG_PM */
618 #ifdef CONFIG_USB_OTG
619 static int ehci_start_port_reset(struct usb_hcd *hcd, unsigned port)
621 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
629 /* start port reset before HNP protocol time out */
630 status = readl(&ehci->regs->port_status[port]);
631 if (!(status & PORT_CONNECT))
634 /* khubd will finish the reset later */
635 if (ehci_is_TDI(ehci)) {
637 (status & ~(PORT_CSC | PORT_PEC | PORT_OCC)),
638 &ehci->regs->port_status[port]);
640 writel(PORT_RESET, &ehci->regs->port_status[port]);
646 #define ehci_start_port_reset NULL
647 #endif /* CONFIG_USB_OTG */
650 static const struct hc_driver ehci_fsl_hc_driver = {
651 .description = hcd_name,
652 .product_desc = "Freescale On-Chip EHCI Host Controller",
653 .hcd_priv_size = sizeof(struct ehci_fsl),
656 * generic hardware linkage
659 .flags = HCD_USB2 | HCD_MEMORY,
662 * basic lifecycle operations
664 .reset = ehci_fsl_setup,
667 .shutdown = ehci_shutdown,
670 * managing i/o requests and associated device resources
672 .urb_enqueue = ehci_urb_enqueue,
673 .urb_dequeue = ehci_urb_dequeue,
674 .endpoint_disable = ehci_endpoint_disable,
675 .endpoint_reset = ehci_endpoint_reset,
680 .get_frame_number = ehci_get_frame,
685 .hub_status_data = ehci_hub_status_data,
686 .hub_control = ehci_hub_control,
687 .bus_suspend = ehci_bus_suspend,
688 .bus_resume = ehci_bus_resume,
689 .start_port_reset = ehci_start_port_reset,
690 .relinquish_port = ehci_relinquish_port,
691 .port_handed_over = ehci_port_handed_over,
693 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
696 static int ehci_fsl_drv_probe(struct platform_device *pdev)
701 /* FIXME we only want one one probe() not two */
702 return usb_hcd_fsl_probe(&ehci_fsl_hc_driver, pdev);
705 static int ehci_fsl_drv_remove(struct platform_device *pdev)
707 struct usb_hcd *hcd = platform_get_drvdata(pdev);
709 /* FIXME we only want one one remove() not two */
710 usb_hcd_fsl_remove(hcd, pdev);
714 MODULE_ALIAS("platform:fsl-ehci");
716 static struct platform_driver ehci_fsl_driver = {
717 .probe = ehci_fsl_drv_probe,
718 .remove = ehci_fsl_drv_remove,
719 .shutdown = usb_hcd_platform_shutdown,
722 .pm = EHCI_FSL_PM_OPS,