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
)
219 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
220 void __iomem
*non_ehci
= hcd
->regs
;
222 portsc
= ehci_readl(ehci
, &ehci
->regs
->port_status
[port_offset
]);
223 portsc
&= ~(PORT_PTS_MSK
| PORT_PTS_PTW
);
226 case FSL_USB2_PHY_ULPI
:
227 portsc
|= PORT_PTS_ULPI
;
229 case FSL_USB2_PHY_SERIAL
:
230 portsc
|= PORT_PTS_SERIAL
;
232 case FSL_USB2_PHY_UTMI_WIDE
:
233 portsc
|= PORT_PTS_PTW
;
235 case FSL_USB2_PHY_UTMI
:
236 /* enable UTMI PHY */
237 setbits32(non_ehci
+ FSL_SOC_USB_CTRL
, CTRL_UTMI_PHY_EN
);
238 portsc
|= PORT_PTS_UTMI
;
240 case FSL_USB2_PHY_NONE
:
243 ehci_writel(ehci
, portsc
, &ehci
->regs
->port_status
[port_offset
]);
246 static void ehci_fsl_usb_setup(struct ehci_hcd
*ehci
)
248 struct usb_hcd
*hcd
= ehci_to_hcd(ehci
);
249 struct fsl_usb2_platform_data
*pdata
;
250 void __iomem
*non_ehci
= hcd
->regs
;
253 pdata
= hcd
->self
.controller
->platform_data
;
255 /* Enable PHY interface in the control reg. */
256 if (pdata
->have_sysif_regs
) {
257 temp
= in_be32(non_ehci
+ FSL_SOC_USB_CTRL
);
258 out_be32(non_ehci
+ FSL_SOC_USB_CTRL
, temp
| 0x00000004);
259 out_be32(non_ehci
+ FSL_SOC_USB_SNOOP1
, 0x0000001b);
262 #if defined(CONFIG_PPC32) && !defined(CONFIG_NOT_COHERENT_CACHE)
264 * Turn on cache snooping hardware, since some PowerPC platforms
265 * wholly rely on hardware to deal with cache coherent
268 /* Setup Snooping for all the 4GB space */
269 /* SNOOP1 starts from 0x0, size 2G */
270 out_be32(non_ehci
+ FSL_SOC_USB_SNOOP1
, 0x0 | SNOOP_SIZE_2GB
);
271 /* SNOOP2 starts from 0x80000000, size 2G */
272 out_be32(non_ehci
+ FSL_SOC_USB_SNOOP2
, 0x80000000 | SNOOP_SIZE_2GB
);
275 if ((pdata
->operating_mode
== FSL_USB2_DR_HOST
) ||
276 (pdata
->operating_mode
== FSL_USB2_DR_OTG
))
277 ehci_fsl_setup_phy(ehci
, pdata
->phy_mode
, 0);
279 if (pdata
->operating_mode
== FSL_USB2_MPH_HOST
) {
280 unsigned int chip
, rev
, svr
;
282 svr
= mfspr(SPRN_SVR
);
284 rev
= (svr
>> 4) & 0xf;
286 /* Deal with USB Erratum #14 on MPC834x Rev 1.0 & 1.1 chips */
287 if ((rev
== 1) && (chip
>= 0x8050) && (chip
<= 0x8055))
288 ehci
->has_fsl_port_bug
= 1;
290 if (pdata
->port_enables
& FSL_USB2_PORT0_ENABLED
)
291 ehci_fsl_setup_phy(ehci
, pdata
->phy_mode
, 0);
292 if (pdata
->port_enables
& FSL_USB2_PORT1_ENABLED
)
293 ehci_fsl_setup_phy(ehci
, pdata
->phy_mode
, 1);
296 if (pdata
->have_sysif_regs
) {
297 #ifdef CONFIG_PPC_85xx
298 out_be32(non_ehci
+ FSL_SOC_USB_PRICTRL
, 0x00000008);
299 out_be32(non_ehci
+ FSL_SOC_USB_AGECNTTHRSH
, 0x00000080);
301 out_be32(non_ehci
+ FSL_SOC_USB_PRICTRL
, 0x0000000c);
302 out_be32(non_ehci
+ FSL_SOC_USB_AGECNTTHRSH
, 0x00000040);
304 out_be32(non_ehci
+ FSL_SOC_USB_SICTRL
, 0x00000001);
308 /* called after powerup, by probe or system-pm "wakeup" */
309 static int ehci_fsl_reinit(struct ehci_hcd
*ehci
)
311 ehci_fsl_usb_setup(ehci
);
312 ehci_port_power(ehci
, 0);
317 /* called during probe() after chip reset completes */
318 static int ehci_fsl_setup(struct usb_hcd
*hcd
)
320 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
322 struct fsl_usb2_platform_data
*pdata
;
324 pdata
= hcd
->self
.controller
->platform_data
;
325 ehci
->big_endian_desc
= pdata
->big_endian_desc
;
326 ehci
->big_endian_mmio
= pdata
->big_endian_mmio
;
328 /* EHCI registers start at offset 0x100 */
329 ehci
->caps
= hcd
->regs
+ 0x100;
330 ehci
->regs
= hcd
->regs
+ 0x100 +
331 HC_LENGTH(ehci
, ehci_readl(ehci
, &ehci
->caps
->hc_capbase
));
332 dbg_hcs_params(ehci
, "reset");
333 dbg_hcc_params(ehci
, "reset");
335 /* cache this readonly data; minimize chip reads */
336 ehci
->hcs_params
= ehci_readl(ehci
, &ehci
->caps
->hcs_params
);
340 retval
= ehci_halt(ehci
);
344 /* data structure init */
345 retval
= ehci_init(hcd
);
353 retval
= ehci_fsl_reinit(ehci
);
358 struct ehci_hcd ehci
;
361 /* Saved USB PHY settings, need to restore after deep sleep. */
368 #ifdef CONFIG_PPC_MPC512x
369 static int ehci_fsl_mpc512x_drv_suspend(struct device
*dev
)
371 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
372 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
373 struct fsl_usb2_platform_data
*pdata
= dev
->platform_data
;
377 u32 mode
= ehci_readl(ehci
, hcd
->regs
+ FSL_SOC_USB_USBMODE
);
378 mode
&= USBMODE_CM_MASK
;
379 tmp
= ehci_readl(ehci
, hcd
->regs
+ 0x140); /* usbcmd */
381 dev_dbg(dev
, "suspend=%d already_suspended=%d "
382 "mode=%d usbcmd %08x\n", pdata
->suspended
,
383 pdata
->already_suspended
, mode
, tmp
);
387 * If the controller is already suspended, then this must be a
388 * PM suspend. Remember this fact, so that we will leave the
389 * controller suspended at PM resume time.
391 if (pdata
->suspended
) {
392 dev_dbg(dev
, "already suspended, leaving early\n");
393 pdata
->already_suspended
= 1;
397 dev_dbg(dev
, "suspending...\n");
399 ehci
->rh_state
= EHCI_RH_SUSPENDED
;
400 dev
->power
.power_state
= PMSG_SUSPEND
;
402 /* ignore non-host interrupts */
403 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
405 /* stop the controller */
406 tmp
= ehci_readl(ehci
, &ehci
->regs
->command
);
408 ehci_writel(ehci
, tmp
, &ehci
->regs
->command
);
410 /* save EHCI registers */
411 pdata
->pm_command
= ehci_readl(ehci
, &ehci
->regs
->command
);
412 pdata
->pm_command
&= ~CMD_RUN
;
413 pdata
->pm_status
= ehci_readl(ehci
, &ehci
->regs
->status
);
414 pdata
->pm_intr_enable
= ehci_readl(ehci
, &ehci
->regs
->intr_enable
);
415 pdata
->pm_frame_index
= ehci_readl(ehci
, &ehci
->regs
->frame_index
);
416 pdata
->pm_segment
= ehci_readl(ehci
, &ehci
->regs
->segment
);
417 pdata
->pm_frame_list
= ehci_readl(ehci
, &ehci
->regs
->frame_list
);
418 pdata
->pm_async_next
= ehci_readl(ehci
, &ehci
->regs
->async_next
);
419 pdata
->pm_configured_flag
=
420 ehci_readl(ehci
, &ehci
->regs
->configured_flag
);
421 pdata
->pm_portsc
= ehci_readl(ehci
, &ehci
->regs
->port_status
[0]);
422 pdata
->pm_usbgenctrl
= ehci_readl(ehci
,
423 hcd
->regs
+ FSL_SOC_USB_USBGENCTRL
);
425 /* clear the W1C bits */
426 pdata
->pm_portsc
&= cpu_to_hc32(ehci
, ~PORT_RWC_BITS
);
428 pdata
->suspended
= 1;
430 /* clear PP to cut power to the port */
431 tmp
= ehci_readl(ehci
, &ehci
->regs
->port_status
[0]);
433 ehci_writel(ehci
, tmp
, &ehci
->regs
->port_status
[0]);
438 static int ehci_fsl_mpc512x_drv_resume(struct device
*dev
)
440 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
441 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
442 struct fsl_usb2_platform_data
*pdata
= dev
->platform_data
;
445 dev_dbg(dev
, "suspend=%d already_suspended=%d\n",
446 pdata
->suspended
, pdata
->already_suspended
);
449 * If the controller was already suspended at suspend time,
450 * then don't resume it now.
452 if (pdata
->already_suspended
) {
453 dev_dbg(dev
, "already suspended, leaving early\n");
454 pdata
->already_suspended
= 0;
458 if (!pdata
->suspended
) {
459 dev_dbg(dev
, "not suspended, leaving early\n");
463 pdata
->suspended
= 0;
465 dev_dbg(dev
, "resuming...\n");
468 tmp
= USBMODE_CM_HOST
| (pdata
->es
? USBMODE_ES
: 0);
469 ehci_writel(ehci
, tmp
, hcd
->regs
+ FSL_SOC_USB_USBMODE
);
471 ehci_writel(ehci
, pdata
->pm_usbgenctrl
,
472 hcd
->regs
+ FSL_SOC_USB_USBGENCTRL
);
473 ehci_writel(ehci
, ISIPHYCTRL_PXE
| ISIPHYCTRL_PHYE
,
474 hcd
->regs
+ FSL_SOC_USB_ISIPHYCTRL
);
476 /* restore EHCI registers */
477 ehci_writel(ehci
, pdata
->pm_command
, &ehci
->regs
->command
);
478 ehci_writel(ehci
, pdata
->pm_intr_enable
, &ehci
->regs
->intr_enable
);
479 ehci_writel(ehci
, pdata
->pm_frame_index
, &ehci
->regs
->frame_index
);
480 ehci_writel(ehci
, pdata
->pm_segment
, &ehci
->regs
->segment
);
481 ehci_writel(ehci
, pdata
->pm_frame_list
, &ehci
->regs
->frame_list
);
482 ehci_writel(ehci
, pdata
->pm_async_next
, &ehci
->regs
->async_next
);
483 ehci_writel(ehci
, pdata
->pm_configured_flag
,
484 &ehci
->regs
->configured_flag
);
485 ehci_writel(ehci
, pdata
->pm_portsc
, &ehci
->regs
->port_status
[0]);
487 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
488 ehci
->rh_state
= EHCI_RH_RUNNING
;
489 dev
->power
.power_state
= PMSG_ON
;
491 tmp
= ehci_readl(ehci
, &ehci
->regs
->command
);
493 ehci_writel(ehci
, tmp
, &ehci
->regs
->command
);
495 usb_hcd_resume_root_hub(hcd
);
500 static inline int ehci_fsl_mpc512x_drv_suspend(struct device
*dev
)
505 static inline int ehci_fsl_mpc512x_drv_resume(struct device
*dev
)
509 #endif /* CONFIG_PPC_MPC512x */
511 static struct ehci_fsl
*hcd_to_ehci_fsl(struct usb_hcd
*hcd
)
513 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
515 return container_of(ehci
, struct ehci_fsl
, ehci
);
518 static int ehci_fsl_drv_suspend(struct device
*dev
)
520 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
521 struct ehci_fsl
*ehci_fsl
= hcd_to_ehci_fsl(hcd
);
522 void __iomem
*non_ehci
= hcd
->regs
;
524 if (of_device_is_compatible(dev
->parent
->of_node
,
525 "fsl,mpc5121-usb2-dr")) {
526 return ehci_fsl_mpc512x_drv_suspend(dev
);
529 ehci_prepare_ports_for_controller_suspend(hcd_to_ehci(hcd
),
530 device_may_wakeup(dev
));
531 if (!fsl_deep_sleep())
534 ehci_fsl
->usb_ctrl
= in_be32(non_ehci
+ FSL_SOC_USB_CTRL
);
538 static int ehci_fsl_drv_resume(struct device
*dev
)
540 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
541 struct ehci_fsl
*ehci_fsl
= hcd_to_ehci_fsl(hcd
);
542 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
543 void __iomem
*non_ehci
= hcd
->regs
;
545 if (of_device_is_compatible(dev
->parent
->of_node
,
546 "fsl,mpc5121-usb2-dr")) {
547 return ehci_fsl_mpc512x_drv_resume(dev
);
550 ehci_prepare_ports_for_controller_resume(ehci
);
551 if (!fsl_deep_sleep())
554 usb_root_hub_lost_power(hcd
->self
.root_hub
);
556 /* Restore USB PHY settings and enable the controller. */
557 out_be32(non_ehci
+ FSL_SOC_USB_CTRL
, ehci_fsl
->usb_ctrl
);
560 ehci_fsl_reinit(ehci
);
565 static int ehci_fsl_drv_restore(struct device
*dev
)
567 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
569 usb_root_hub_lost_power(hcd
->self
.root_hub
);
573 static struct dev_pm_ops ehci_fsl_pm_ops
= {
574 .suspend
= ehci_fsl_drv_suspend
,
575 .resume
= ehci_fsl_drv_resume
,
576 .restore
= ehci_fsl_drv_restore
,
579 #define EHCI_FSL_PM_OPS (&ehci_fsl_pm_ops)
581 #define EHCI_FSL_PM_OPS NULL
582 #endif /* CONFIG_PM */
584 #ifdef CONFIG_USB_OTG
585 static int ehci_start_port_reset(struct usb_hcd
*hcd
, unsigned port
)
587 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
595 /* start port reset before HNP protocol time out */
596 status
= readl(&ehci
->regs
->port_status
[port
]);
597 if (!(status
& PORT_CONNECT
))
600 /* khubd will finish the reset later */
601 if (ehci_is_TDI(ehci
)) {
603 (status
& ~(PORT_CSC
| PORT_PEC
| PORT_OCC
)),
604 &ehci
->regs
->port_status
[port
]);
606 writel(PORT_RESET
, &ehci
->regs
->port_status
[port
]);
612 #define ehci_start_port_reset NULL
613 #endif /* CONFIG_USB_OTG */
616 static const struct hc_driver ehci_fsl_hc_driver
= {
617 .description
= hcd_name
,
618 .product_desc
= "Freescale On-Chip EHCI Host Controller",
619 .hcd_priv_size
= sizeof(struct ehci_fsl
),
622 * generic hardware linkage
625 .flags
= HCD_USB2
| HCD_MEMORY
,
628 * basic lifecycle operations
630 .reset
= ehci_fsl_setup
,
633 .shutdown
= ehci_shutdown
,
636 * managing i/o requests and associated device resources
638 .urb_enqueue
= ehci_urb_enqueue
,
639 .urb_dequeue
= ehci_urb_dequeue
,
640 .endpoint_disable
= ehci_endpoint_disable
,
641 .endpoint_reset
= ehci_endpoint_reset
,
646 .get_frame_number
= ehci_get_frame
,
651 .hub_status_data
= ehci_hub_status_data
,
652 .hub_control
= ehci_hub_control
,
653 .bus_suspend
= ehci_bus_suspend
,
654 .bus_resume
= ehci_bus_resume
,
655 .start_port_reset
= ehci_start_port_reset
,
656 .relinquish_port
= ehci_relinquish_port
,
657 .port_handed_over
= ehci_port_handed_over
,
659 .clear_tt_buffer_complete
= ehci_clear_tt_buffer_complete
,
662 static int ehci_fsl_drv_probe(struct platform_device
*pdev
)
667 /* FIXME we only want one one probe() not two */
668 return usb_hcd_fsl_probe(&ehci_fsl_hc_driver
, pdev
);
671 static int ehci_fsl_drv_remove(struct platform_device
*pdev
)
673 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
675 /* FIXME we only want one one remove() not two */
676 usb_hcd_fsl_remove(hcd
, pdev
);
680 MODULE_ALIAS("platform:fsl-ehci");
682 static struct platform_driver ehci_fsl_driver
= {
683 .probe
= ehci_fsl_drv_probe
,
684 .remove
= ehci_fsl_drv_remove
,
685 .shutdown
= usb_hcd_platform_shutdown
,
688 .pm
= EHCI_FSL_PM_OPS
,