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 = 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 ehci_hcd *ehci,
215 enum fsl_usb2_phy_modes phy_mode,
216 unsigned int port_offset)
219 struct usb_hcd *hcd = ehci_to_hcd(ehci);
220 void __iomem *non_ehci = hcd->regs;
221 struct fsl_usb2_platform_data *pdata;
223 pdata = hcd->self.controller->platform_data;
225 portsc = ehci_readl(ehci, &ehci->regs->port_status[port_offset]);
226 portsc &= ~(PORT_PTS_MSK | PORT_PTS_PTW);
229 case FSL_USB2_PHY_ULPI:
230 portsc |= PORT_PTS_ULPI;
232 case FSL_USB2_PHY_SERIAL:
233 portsc |= PORT_PTS_SERIAL;
235 case FSL_USB2_PHY_UTMI_WIDE:
236 portsc |= PORT_PTS_PTW;
238 case FSL_USB2_PHY_UTMI:
239 /* enable UTMI PHY */
240 if (pdata->have_sysif_regs)
241 setbits32(non_ehci + FSL_SOC_USB_CTRL,
243 portsc |= PORT_PTS_UTMI;
245 case FSL_USB2_PHY_NONE:
248 ehci_writel(ehci, portsc, &ehci->regs->port_status[port_offset]);
251 static void ehci_fsl_usb_setup(struct ehci_hcd *ehci)
253 struct usb_hcd *hcd = ehci_to_hcd(ehci);
254 struct fsl_usb2_platform_data *pdata;
255 void __iomem *non_ehci = hcd->regs;
258 pdata = hcd->self.controller->platform_data;
260 /* Enable PHY interface in the control reg. */
261 if (pdata->have_sysif_regs) {
262 temp = in_be32(non_ehci + FSL_SOC_USB_CTRL);
263 out_be32(non_ehci + FSL_SOC_USB_CTRL, temp | 0x00000004);
266 * Turn on cache snooping hardware, since some PowerPC platforms
267 * wholly rely on hardware to deal with cache coherent
270 /* Setup Snooping for all the 4GB space */
271 /* SNOOP1 starts from 0x0, size 2G */
272 out_be32(non_ehci + FSL_SOC_USB_SNOOP1, 0x0 | SNOOP_SIZE_2GB);
273 /* SNOOP2 starts from 0x80000000, size 2G */
274 out_be32(non_ehci + FSL_SOC_USB_SNOOP2, 0x80000000 | SNOOP_SIZE_2GB);
277 if ((pdata->operating_mode == FSL_USB2_DR_HOST) ||
278 (pdata->operating_mode == FSL_USB2_DR_OTG))
279 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 0);
281 if (pdata->operating_mode == FSL_USB2_MPH_HOST) {
282 unsigned int chip, rev, svr;
284 svr = mfspr(SPRN_SVR);
286 rev = (svr >> 4) & 0xf;
288 /* Deal with USB Erratum #14 on MPC834x Rev 1.0 & 1.1 chips */
289 if ((rev == 1) && (chip >= 0x8050) && (chip <= 0x8055))
290 ehci->has_fsl_port_bug = 1;
292 if (pdata->port_enables & FSL_USB2_PORT0_ENABLED)
293 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 0);
294 if (pdata->port_enables & FSL_USB2_PORT1_ENABLED)
295 ehci_fsl_setup_phy(ehci, pdata->phy_mode, 1);
298 if (pdata->have_sysif_regs) {
299 #ifdef CONFIG_PPC_85xx
300 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x00000008);
301 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000080);
303 out_be32(non_ehci + FSL_SOC_USB_PRICTRL, 0x0000000c);
304 out_be32(non_ehci + FSL_SOC_USB_AGECNTTHRSH, 0x00000040);
306 out_be32(non_ehci + FSL_SOC_USB_SICTRL, 0x00000001);
310 /* called after powerup, by probe or system-pm "wakeup" */
311 static int ehci_fsl_reinit(struct ehci_hcd *ehci)
313 ehci_fsl_usb_setup(ehci);
314 ehci_port_power(ehci, 0);
319 /* called during probe() after chip reset completes */
320 static int ehci_fsl_setup(struct usb_hcd *hcd)
322 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
324 struct fsl_usb2_platform_data *pdata;
327 dev = hcd->self.controller;
328 pdata = hcd->self.controller->platform_data;
329 ehci->big_endian_desc = pdata->big_endian_desc;
330 ehci->big_endian_mmio = pdata->big_endian_mmio;
332 /* EHCI registers start at offset 0x100 */
333 ehci->caps = hcd->regs + 0x100;
334 ehci->regs = hcd->regs + 0x100 +
335 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
336 dbg_hcs_params(ehci, "reset");
337 dbg_hcc_params(ehci, "reset");
339 /* cache this readonly data; minimize chip reads */
340 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
344 retval = ehci_halt(ehci);
348 /* data structure init */
349 retval = ehci_init(hcd);
357 if (of_device_is_compatible(dev->parent->of_node,
358 "fsl,mpc5121-usb2-dr")) {
360 * set SBUSCFG:AHBBRST so that control msgs don't
361 * fail when doing heavy PATA writes.
363 ehci_writel(ehci, SBUSCFG_INCR8,
364 hcd->regs + FSL_SOC_USB_SBUSCFG);
367 retval = ehci_fsl_reinit(ehci);
372 struct ehci_hcd ehci;
375 /* Saved USB PHY settings, need to restore after deep sleep. */
382 #ifdef CONFIG_PPC_MPC512x
383 static int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
385 struct usb_hcd *hcd = dev_get_drvdata(dev);
386 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
387 struct fsl_usb2_platform_data *pdata = dev->platform_data;
391 u32 mode = ehci_readl(ehci, hcd->regs + FSL_SOC_USB_USBMODE);
392 mode &= USBMODE_CM_MASK;
393 tmp = ehci_readl(ehci, hcd->regs + 0x140); /* usbcmd */
395 dev_dbg(dev, "suspend=%d already_suspended=%d "
396 "mode=%d usbcmd %08x\n", pdata->suspended,
397 pdata->already_suspended, mode, tmp);
401 * If the controller is already suspended, then this must be a
402 * PM suspend. Remember this fact, so that we will leave the
403 * controller suspended at PM resume time.
405 if (pdata->suspended) {
406 dev_dbg(dev, "already suspended, leaving early\n");
407 pdata->already_suspended = 1;
411 dev_dbg(dev, "suspending...\n");
413 ehci->rh_state = EHCI_RH_SUSPENDED;
414 dev->power.power_state = PMSG_SUSPEND;
416 /* ignore non-host interrupts */
417 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
419 /* stop the controller */
420 tmp = ehci_readl(ehci, &ehci->regs->command);
422 ehci_writel(ehci, tmp, &ehci->regs->command);
424 /* save EHCI registers */
425 pdata->pm_command = ehci_readl(ehci, &ehci->regs->command);
426 pdata->pm_command &= ~CMD_RUN;
427 pdata->pm_status = ehci_readl(ehci, &ehci->regs->status);
428 pdata->pm_intr_enable = ehci_readl(ehci, &ehci->regs->intr_enable);
429 pdata->pm_frame_index = ehci_readl(ehci, &ehci->regs->frame_index);
430 pdata->pm_segment = ehci_readl(ehci, &ehci->regs->segment);
431 pdata->pm_frame_list = ehci_readl(ehci, &ehci->regs->frame_list);
432 pdata->pm_async_next = ehci_readl(ehci, &ehci->regs->async_next);
433 pdata->pm_configured_flag =
434 ehci_readl(ehci, &ehci->regs->configured_flag);
435 pdata->pm_portsc = ehci_readl(ehci, &ehci->regs->port_status[0]);
436 pdata->pm_usbgenctrl = ehci_readl(ehci,
437 hcd->regs + FSL_SOC_USB_USBGENCTRL);
439 /* clear the W1C bits */
440 pdata->pm_portsc &= cpu_to_hc32(ehci, ~PORT_RWC_BITS);
442 pdata->suspended = 1;
444 /* clear PP to cut power to the port */
445 tmp = ehci_readl(ehci, &ehci->regs->port_status[0]);
447 ehci_writel(ehci, tmp, &ehci->regs->port_status[0]);
452 static int ehci_fsl_mpc512x_drv_resume(struct device *dev)
454 struct usb_hcd *hcd = dev_get_drvdata(dev);
455 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
456 struct fsl_usb2_platform_data *pdata = dev->platform_data;
459 dev_dbg(dev, "suspend=%d already_suspended=%d\n",
460 pdata->suspended, pdata->already_suspended);
463 * If the controller was already suspended at suspend time,
464 * then don't resume it now.
466 if (pdata->already_suspended) {
467 dev_dbg(dev, "already suspended, leaving early\n");
468 pdata->already_suspended = 0;
472 if (!pdata->suspended) {
473 dev_dbg(dev, "not suspended, leaving early\n");
477 pdata->suspended = 0;
479 dev_dbg(dev, "resuming...\n");
482 tmp = USBMODE_CM_HOST | (pdata->es ? USBMODE_ES : 0);
483 ehci_writel(ehci, tmp, hcd->regs + FSL_SOC_USB_USBMODE);
485 ehci_writel(ehci, pdata->pm_usbgenctrl,
486 hcd->regs + FSL_SOC_USB_USBGENCTRL);
487 ehci_writel(ehci, ISIPHYCTRL_PXE | ISIPHYCTRL_PHYE,
488 hcd->regs + FSL_SOC_USB_ISIPHYCTRL);
490 ehci_writel(ehci, SBUSCFG_INCR8, hcd->regs + FSL_SOC_USB_SBUSCFG);
492 /* restore EHCI registers */
493 ehci_writel(ehci, pdata->pm_command, &ehci->regs->command);
494 ehci_writel(ehci, pdata->pm_intr_enable, &ehci->regs->intr_enable);
495 ehci_writel(ehci, pdata->pm_frame_index, &ehci->regs->frame_index);
496 ehci_writel(ehci, pdata->pm_segment, &ehci->regs->segment);
497 ehci_writel(ehci, pdata->pm_frame_list, &ehci->regs->frame_list);
498 ehci_writel(ehci, pdata->pm_async_next, &ehci->regs->async_next);
499 ehci_writel(ehci, pdata->pm_configured_flag,
500 &ehci->regs->configured_flag);
501 ehci_writel(ehci, pdata->pm_portsc, &ehci->regs->port_status[0]);
503 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
504 ehci->rh_state = EHCI_RH_RUNNING;
505 dev->power.power_state = PMSG_ON;
507 tmp = ehci_readl(ehci, &ehci->regs->command);
509 ehci_writel(ehci, tmp, &ehci->regs->command);
511 usb_hcd_resume_root_hub(hcd);
516 static inline int ehci_fsl_mpc512x_drv_suspend(struct device *dev)
521 static inline int ehci_fsl_mpc512x_drv_resume(struct device *dev)
525 #endif /* CONFIG_PPC_MPC512x */
527 static struct ehci_fsl *hcd_to_ehci_fsl(struct usb_hcd *hcd)
529 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
531 return container_of(ehci, struct ehci_fsl, ehci);
534 static int ehci_fsl_drv_suspend(struct device *dev)
536 struct usb_hcd *hcd = dev_get_drvdata(dev);
537 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
538 void __iomem *non_ehci = hcd->regs;
540 if (of_device_is_compatible(dev->parent->of_node,
541 "fsl,mpc5121-usb2-dr")) {
542 return ehci_fsl_mpc512x_drv_suspend(dev);
545 ehci_prepare_ports_for_controller_suspend(hcd_to_ehci(hcd),
546 device_may_wakeup(dev));
547 if (!fsl_deep_sleep())
550 ehci_fsl->usb_ctrl = in_be32(non_ehci + FSL_SOC_USB_CTRL);
554 static int ehci_fsl_drv_resume(struct device *dev)
556 struct usb_hcd *hcd = dev_get_drvdata(dev);
557 struct ehci_fsl *ehci_fsl = hcd_to_ehci_fsl(hcd);
558 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
559 void __iomem *non_ehci = hcd->regs;
561 if (of_device_is_compatible(dev->parent->of_node,
562 "fsl,mpc5121-usb2-dr")) {
563 return ehci_fsl_mpc512x_drv_resume(dev);
566 ehci_prepare_ports_for_controller_resume(ehci);
567 if (!fsl_deep_sleep())
570 usb_root_hub_lost_power(hcd->self.root_hub);
572 /* Restore USB PHY settings and enable the controller. */
573 out_be32(non_ehci + FSL_SOC_USB_CTRL, ehci_fsl->usb_ctrl);
576 ehci_fsl_reinit(ehci);
581 static int ehci_fsl_drv_restore(struct device *dev)
583 struct usb_hcd *hcd = dev_get_drvdata(dev);
585 usb_root_hub_lost_power(hcd->self.root_hub);
589 static struct dev_pm_ops ehci_fsl_pm_ops = {
590 .suspend = ehci_fsl_drv_suspend,
591 .resume = ehci_fsl_drv_resume,
592 .restore = ehci_fsl_drv_restore,
595 #define EHCI_FSL_PM_OPS (&ehci_fsl_pm_ops)
597 #define EHCI_FSL_PM_OPS NULL
598 #endif /* CONFIG_PM */
600 #ifdef CONFIG_USB_OTG
601 static int ehci_start_port_reset(struct usb_hcd *hcd, unsigned port)
603 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
611 /* start port reset before HNP protocol time out */
612 status = readl(&ehci->regs->port_status[port]);
613 if (!(status & PORT_CONNECT))
616 /* khubd will finish the reset later */
617 if (ehci_is_TDI(ehci)) {
619 (status & ~(PORT_CSC | PORT_PEC | PORT_OCC)),
620 &ehci->regs->port_status[port]);
622 writel(PORT_RESET, &ehci->regs->port_status[port]);
628 #define ehci_start_port_reset NULL
629 #endif /* CONFIG_USB_OTG */
632 static const struct hc_driver ehci_fsl_hc_driver = {
633 .description = hcd_name,
634 .product_desc = "Freescale On-Chip EHCI Host Controller",
635 .hcd_priv_size = sizeof(struct ehci_fsl),
638 * generic hardware linkage
641 .flags = HCD_USB2 | HCD_MEMORY,
644 * basic lifecycle operations
646 .reset = ehci_fsl_setup,
649 .shutdown = ehci_shutdown,
652 * managing i/o requests and associated device resources
654 .urb_enqueue = ehci_urb_enqueue,
655 .urb_dequeue = ehci_urb_dequeue,
656 .endpoint_disable = ehci_endpoint_disable,
657 .endpoint_reset = ehci_endpoint_reset,
662 .get_frame_number = ehci_get_frame,
667 .hub_status_data = ehci_hub_status_data,
668 .hub_control = ehci_hub_control,
669 .bus_suspend = ehci_bus_suspend,
670 .bus_resume = ehci_bus_resume,
671 .start_port_reset = ehci_start_port_reset,
672 .relinquish_port = ehci_relinquish_port,
673 .port_handed_over = ehci_port_handed_over,
675 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
678 static int ehci_fsl_drv_probe(struct platform_device *pdev)
683 /* FIXME we only want one one probe() not two */
684 return usb_hcd_fsl_probe(&ehci_fsl_hc_driver, pdev);
687 static int ehci_fsl_drv_remove(struct platform_device *pdev)
689 struct usb_hcd *hcd = platform_get_drvdata(pdev);
691 /* FIXME we only want one one remove() not two */
692 usb_hcd_fsl_remove(hcd, pdev);
696 MODULE_ALIAS("platform:fsl-ehci");
698 static struct platform_driver ehci_fsl_driver = {
699 .probe = ehci_fsl_drv_probe,
700 .remove = ehci_fsl_drv_remove,
701 .shutdown = usb_hcd_platform_shutdown,
704 .pm = EHCI_FSL_PM_OPS,