2 * Copyright 2005-2009 MontaVista Software, Inc.
3 * Copyright 2008 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 = otg_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,
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, 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 ehci_hcd *ehci,
215 enum fsl_usb2_phy_modes phy_mode,
216 unsigned int port_offset)
220 portsc = ehci_readl(ehci, &ehci->regs->port_status[port_offset]);
221 portsc &= ~(PORT_PTS_MSK | PORT_PTS_PTW);
224 case FSL_USB2_PHY_ULPI:
225 portsc |= PORT_PTS_ULPI;
227 case FSL_USB2_PHY_SERIAL:
228 portsc |= PORT_PTS_SERIAL;
230 case FSL_USB2_PHY_UTMI_WIDE:
231 portsc |= PORT_PTS_PTW;
233 case FSL_USB2_PHY_UTMI:
234 portsc |= PORT_PTS_UTMI;
236 case FSL_USB2_PHY_NONE:
239 ehci_writel(ehci, portsc, &ehci->regs->port_status[port_offset]);
242 static void ehci_fsl_usb_setup(struct ehci_hcd *ehci)
244 struct usb_hcd *hcd = ehci_to_hcd(ehci);
245 struct fsl_usb2_platform_data *pdata;
246 void __iomem *non_ehci = hcd->regs;
249 pdata = hcd->self.controller->platform_data;
251 /* Enable PHY interface in the control reg. */
252 if (pdata->have_sysif_regs) {
253 temp = in_be32(non_ehci + FSL_SOC_USB_CTRL);
254 out_be32(non_ehci + FSL_SOC_USB_CTRL, temp | 0x00000004);
255 out_be32(non_ehci + FSL_SOC_USB_SNOOP1, 0x0000001b);
258 #if defined(CONFIG_PPC32) && !defined(CONFIG_NOT_COHERENT_CACHE)
260 * Turn on cache snooping hardware, since some PowerPC platforms
261 * wholly rely on hardware to deal with cache coherent
264 /* Setup Snooping for all the 4GB space */
265 /* SNOOP1 starts from 0x0, size 2G */
266 out_be32(non_ehci + FSL_SOC_USB_SNOOP1, 0x0 | SNOOP_SIZE_2GB);
267 /* SNOOP2 starts from 0x80000000, size 2G */
268 out_be32(non_ehci + FSL_SOC_USB_SNOOP2, 0x80000000 | SNOOP_SIZE_2GB);
271 if ((pdata->operating_mode == FSL_USB2_DR_HOST) ||
272 (pdata->operating_mode == FSL_USB2_DR_OTG))
273 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 0);
275 if (pdata->operating_mode == FSL_USB2_MPH_HOST) {
276 unsigned int chip, rev, svr;
278 svr = mfspr(SPRN_SVR);
280 rev = (svr >> 4) & 0xf;
282 /* Deal with USB Erratum #14 on MPC834x Rev 1.0 & 1.1 chips */
283 if ((rev == 1) && (chip >= 0x8050) && (chip <= 0x8055))
284 ehci->has_fsl_port_bug = 1;
286 if (pdata->port_enables & FSL_USB2_PORT0_ENABLED)
287 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 0);
288 if (pdata->port_enables & FSL_USB2_PORT1_ENABLED)
289 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 1);
292 if (pdata->have_sysif_regs) {
293 #ifdef CONFIG_PPC_85xx
294 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x00000008);
295 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000080);
297 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x0000000c);
298 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000040);
300 out_be32(non_ehci + FSL_SOC_USB_SICTRL, 0x00000001);
304 /* called after powerup, by probe or system-pm "wakeup" */
305 static int ehci_fsl_reinit(struct ehci_hcd *ehci)
307 ehci_fsl_usb_setup(ehci);
308 ehci_port_power(ehci, 0);
313 /* called during probe() after chip reset completes */
314 static int ehci_fsl_setup(struct usb_hcd *hcd)
316 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
318 struct fsl_usb2_platform_data *pdata;
321 dev = hcd->self.controller;
322 pdata = hcd->self.controller->platform_data;
323 ehci->big_endian_desc = pdata->big_endian_desc;
324 ehci->big_endian_mmio = pdata->big_endian_mmio;
326 /* EHCI registers start at offset 0x100 */
327 ehci->caps = hcd->regs + 0x100;
328 ehci->regs = hcd->regs + 0x100 +
329 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
330 dbg_hcs_params(ehci, "reset");
331 dbg_hcc_params(ehci, "reset");
333 /* cache this readonly data; minimize chip reads */
334 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
338 retval = ehci_halt(ehci);
342 /* data structure init */
343 retval = ehci_init(hcd);
351 if (of_device_is_compatible(dev->parent->of_node,
352 "fsl,mpc5121-usb2-dr")) {
354 * set SBUSCFG:AHBBRST so that control msgs don't
355 * fail when doing heavy PATA writes.
357 ehci_writel(ehci, SBUSCFG_INCR8,
358 hcd->regs + FSL_SOC_USB_SBUSCFG);
361 retval = ehci_fsl_reinit(ehci);
366 struct ehci_hcd ehci;
369 /* Saved USB PHY settings, need to restore after deep sleep. */
376 #ifdef CONFIG_PPC_MPC512x
377 static int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
379 struct usb_hcd *hcd = dev_get_drvdata(dev);
380 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
381 struct fsl_usb2_platform_data *pdata = dev->platform_data;
385 u32 mode = ehci_readl(ehci, hcd->regs + FSL_SOC_USB_USBMODE);
386 mode &= USBMODE_CM_MASK;
387 tmp = ehci_readl(ehci, hcd->regs + 0x140); /* usbcmd */
389 dev_dbg(dev, "suspend=%d already_suspended=%d "
390 "mode=%d usbcmd %08x\n", pdata->suspended,
391 pdata->already_suspended, mode, tmp);
395 * If the controller is already suspended, then this must be a
396 * PM suspend. Remember this fact, so that we will leave the
397 * controller suspended at PM resume time.
399 if (pdata->suspended) {
400 dev_dbg(dev, "already suspended, leaving early\n");
401 pdata->already_suspended = 1;
405 dev_dbg(dev, "suspending...\n");
407 ehci->rh_state = EHCI_RH_SUSPENDED;
408 dev->power.power_state = PMSG_SUSPEND;
410 /* ignore non-host interrupts */
411 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
413 /* stop the controller */
414 tmp = ehci_readl(ehci, &ehci->regs->command);
416 ehci_writel(ehci, tmp, &ehci->regs->command);
418 /* save EHCI registers */
419 pdata->pm_command = ehci_readl(ehci, &ehci->regs->command);
420 pdata->pm_command &= ~CMD_RUN;
421 pdata->pm_status = ehci_readl(ehci, &ehci->regs->status);
422 pdata->pm_intr_enable = ehci_readl(ehci, &ehci->regs->intr_enable);
423 pdata->pm_frame_index = ehci_readl(ehci, &ehci->regs->frame_index);
424 pdata->pm_segment = ehci_readl(ehci, &ehci->regs->segment);
425 pdata->pm_frame_list = ehci_readl(ehci, &ehci->regs->frame_list);
426 pdata->pm_async_next = ehci_readl(ehci, &ehci->regs->async_next);
427 pdata->pm_configured_flag =
428 ehci_readl(ehci, &ehci->regs->configured_flag);
429 pdata->pm_portsc = ehci_readl(ehci, &ehci->regs->port_status[0]);
430 pdata->pm_usbgenctrl = ehci_readl(ehci,
431 hcd->regs + FSL_SOC_USB_USBGENCTRL);
433 /* clear the W1C bits */
434 pdata->pm_portsc &= cpu_to_hc32(ehci, ~PORT_RWC_BITS);
436 pdata->suspended = 1;
438 /* clear PP to cut power to the port */
439 tmp = ehci_readl(ehci, &ehci->regs->port_status[0]);
441 ehci_writel(ehci, tmp, &ehci->regs->port_status[0]);
446 static int ehci_fsl_mpc512x_drv_resume(struct device *dev)
448 struct usb_hcd *hcd = dev_get_drvdata(dev);
449 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
450 struct fsl_usb2_platform_data *pdata = dev->platform_data;
453 dev_dbg(dev, "suspend=%d already_suspended=%d\n",
454 pdata->suspended, pdata->already_suspended);
457 * If the controller was already suspended at suspend time,
458 * then don't resume it now.
460 if (pdata->already_suspended) {
461 dev_dbg(dev, "already suspended, leaving early\n");
462 pdata->already_suspended = 0;
466 if (!pdata->suspended) {
467 dev_dbg(dev, "not suspended, leaving early\n");
471 pdata->suspended = 0;
473 dev_dbg(dev, "resuming...\n");
476 tmp = USBMODE_CM_HOST | (pdata->es ? USBMODE_ES : 0);
477 ehci_writel(ehci, tmp, hcd->regs + FSL_SOC_USB_USBMODE);
479 ehci_writel(ehci, pdata->pm_usbgenctrl,
480 hcd->regs + FSL_SOC_USB_USBGENCTRL);
481 ehci_writel(ehci, ISIPHYCTRL_PXE | ISIPHYCTRL_PHYE,
482 hcd->regs + FSL_SOC_USB_ISIPHYCTRL);
484 ehci_writel(ehci, SBUSCFG_INCR8, hcd->regs + FSL_SOC_USB_SBUSCFG);
486 /* restore EHCI registers */
487 ehci_writel(ehci, pdata->pm_command, &ehci->regs->command);
488 ehci_writel(ehci, pdata->pm_intr_enable, &ehci->regs->intr_enable);
489 ehci_writel(ehci, pdata->pm_frame_index, &ehci->regs->frame_index);
490 ehci_writel(ehci, pdata->pm_segment, &ehci->regs->segment);
491 ehci_writel(ehci, pdata->pm_frame_list, &ehci->regs->frame_list);
492 ehci_writel(ehci, pdata->pm_async_next, &ehci->regs->async_next);
493 ehci_writel(ehci, pdata->pm_configured_flag,
494 &ehci->regs->configured_flag);
495 ehci_writel(ehci, pdata->pm_portsc, &ehci->regs->port_status[0]);
497 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
498 ehci->rh_state = EHCI_RH_RUNNING;
499 dev->power.power_state = PMSG_ON;
501 tmp = ehci_readl(ehci, &ehci->regs->command);
503 ehci_writel(ehci, tmp, &ehci->regs->command);
505 usb_hcd_resume_root_hub(hcd);
510 static inline int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
515 static inline int ehci_fsl_mpc512x_drv_resume(struct device *dev)
519 #endif /* CONFIG_PPC_MPC512x */
521 static struct ehci_fsl *hcd_to_ehci_fsl(struct usb_hcd *hcd)
523 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
525 return container_of(ehci, struct ehci_fsl, ehci);
528 static int ehci_fsl_drv_suspend(struct device *dev)
530 struct usb_hcd *hcd = dev_get_drvdata(dev);
531 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
532 void __iomem *non_ehci = hcd->regs;
534 if (of_device_is_compatible(dev->parent->of_node,
535 "fsl,mpc5121-usb2-dr")) {
536 return ehci_fsl_mpc512x_drv_suspend(dev);
539 ehci_prepare_ports_for_controller_suspend(hcd_to_ehci(hcd),
540 device_may_wakeup(dev));
541 if (!fsl_deep_sleep())
544 ehci_fsl->usb_ctrl = in_be32(non_ehci + FSL_SOC_USB_CTRL);
548 static int ehci_fsl_drv_resume(struct device *dev)
550 struct usb_hcd *hcd = dev_get_drvdata(dev);
551 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
552 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
553 void __iomem *non_ehci = hcd->regs;
555 if (of_device_is_compatible(dev->parent->of_node,
556 "fsl,mpc5121-usb2-dr")) {
557 return ehci_fsl_mpc512x_drv_resume(dev);
560 ehci_prepare_ports_for_controller_resume(ehci);
561 if (!fsl_deep_sleep())
564 usb_root_hub_lost_power(hcd->self.root_hub);
566 /* Restore USB PHY settings and enable the controller. */
567 out_be32(non_ehci + FSL_SOC_USB_CTRL, ehci_fsl->usb_ctrl);
570 ehci_fsl_reinit(ehci);
575 static int ehci_fsl_drv_restore(struct device *dev)
577 struct usb_hcd *hcd = dev_get_drvdata(dev);
579 usb_root_hub_lost_power(hcd->self.root_hub);
583 static struct dev_pm_ops ehci_fsl_pm_ops = {
584 .suspend = ehci_fsl_drv_suspend,
585 .resume = ehci_fsl_drv_resume,
586 .restore = ehci_fsl_drv_restore,
589 #define EHCI_FSL_PM_OPS (&ehci_fsl_pm_ops)
591 #define EHCI_FSL_PM_OPS NULL
592 #endif /* CONFIG_PM */
594 #ifdef CONFIG_USB_OTG
595 static int ehci_start_port_reset(struct usb_hcd *hcd, unsigned port)
597 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
605 /* start port reset before HNP protocol time out */
606 status = readl(&ehci->regs->port_status[port]);
607 if (!(status & PORT_CONNECT))
610 /* khubd will finish the reset later */
611 if (ehci_is_TDI(ehci)) {
613 (status & ~(PORT_CSC | PORT_PEC | PORT_OCC)),
614 &ehci->regs->port_status[port]);
616 writel(PORT_RESET, &ehci->regs->port_status[port]);
622 #define ehci_start_port_reset NULL
623 #endif /* CONFIG_USB_OTG */
626 static const struct hc_driver ehci_fsl_hc_driver = {
627 .description = hcd_name,
628 .product_desc = "Freescale On-Chip EHCI Host Controller",
629 .hcd_priv_size = sizeof(struct ehci_fsl),
632 * generic hardware linkage
635 .flags = HCD_USB2 | HCD_MEMORY,
638 * basic lifecycle operations
640 .reset = ehci_fsl_setup,
643 .shutdown = ehci_shutdown,
646 * managing i/o requests and associated device resources
648 .urb_enqueue = ehci_urb_enqueue,
649 .urb_dequeue = ehci_urb_dequeue,
650 .endpoint_disable = ehci_endpoint_disable,
651 .endpoint_reset = ehci_endpoint_reset,
656 .get_frame_number = ehci_get_frame,
661 .hub_status_data = ehci_hub_status_data,
662 .hub_control = ehci_hub_control,
663 .bus_suspend = ehci_bus_suspend,
664 .bus_resume = ehci_bus_resume,
665 .start_port_reset = ehci_start_port_reset,
666 .relinquish_port = ehci_relinquish_port,
667 .port_handed_over = ehci_port_handed_over,
669 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
672 static int ehci_fsl_drv_probe(struct platform_device *pdev)
677 /* FIXME we only want one one probe() not two */
678 return usb_hcd_fsl_probe(&ehci_fsl_hc_driver, pdev);
681 static int ehci_fsl_drv_remove(struct platform_device *pdev)
683 struct usb_hcd *hcd = platform_get_drvdata(pdev);
685 /* FIXME we only want one one remove() not two */
686 usb_hcd_fsl_remove(hcd, pdev);
690 MODULE_ALIAS("platform:fsl-ehci");
692 static struct platform_driver ehci_fsl_driver = {
693 .probe = ehci_fsl_drv_probe,
694 .remove = ehci_fsl_drv_remove,
695 .shutdown = usb_hcd_platform_shutdown,
698 .pm = EHCI_FSL_PM_OPS,