2 * OHCI HCD (Host Controller Driver) for USB.
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
6 * (C) Copyright 2002 Hewlett-Packard Company
10 * Written by Christopher Hoover <ch@hpl.hp.com>
11 * Based on fragments of previous driver by Russell King et al.
13 * Modified for LH7A404 from ohci-sa1111.c
14 * by Durgesh Pattamatta <pattamattad@sharpsec.com>
16 * Modified for pxa27x from ohci-lh7a404.c
17 * by Nick Bane <nick@cecomputing.co.uk> 26-8-2004
19 * This file is licenced under the GPL.
22 #include <linux/clk.h>
23 #include <linux/device.h>
24 #include <linux/dma-mapping.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/of_platform.h>
29 #include <linux/of_gpio.h>
30 #include <linux/platform_data/usb-ohci-pxa27x.h>
31 #include <linux/platform_data/usb-pxa3xx-ulpi.h>
32 #include <linux/platform_device.h>
33 #include <linux/regulator/consumer.h>
34 #include <linux/signal.h>
35 #include <linux/usb.h>
36 #include <linux/usb/hcd.h>
37 #include <linux/usb/otg.h>
39 #include <mach/hardware.h>
43 #define DRIVER_DESC "OHCI PXA27x/PXA3x driver"
46 * UHC: USB Host Controller (OHCI-like) register definitions
48 #define UHCREV (0x0000) /* UHC HCI Spec Revision */
49 #define UHCHCON (0x0004) /* UHC Host Control Register */
50 #define UHCCOMS (0x0008) /* UHC Command Status Register */
51 #define UHCINTS (0x000C) /* UHC Interrupt Status Register */
52 #define UHCINTE (0x0010) /* UHC Interrupt Enable */
53 #define UHCINTD (0x0014) /* UHC Interrupt Disable */
54 #define UHCHCCA (0x0018) /* UHC Host Controller Comm. Area */
55 #define UHCPCED (0x001C) /* UHC Period Current Endpt Descr */
56 #define UHCCHED (0x0020) /* UHC Control Head Endpt Descr */
57 #define UHCCCED (0x0024) /* UHC Control Current Endpt Descr */
58 #define UHCBHED (0x0028) /* UHC Bulk Head Endpt Descr */
59 #define UHCBCED (0x002C) /* UHC Bulk Current Endpt Descr */
60 #define UHCDHEAD (0x0030) /* UHC Done Head */
61 #define UHCFMI (0x0034) /* UHC Frame Interval */
62 #define UHCFMR (0x0038) /* UHC Frame Remaining */
63 #define UHCFMN (0x003C) /* UHC Frame Number */
64 #define UHCPERS (0x0040) /* UHC Periodic Start */
65 #define UHCLS (0x0044) /* UHC Low Speed Threshold */
67 #define UHCRHDA (0x0048) /* UHC Root Hub Descriptor A */
68 #define UHCRHDA_NOCP (1 << 12) /* No over current protection */
69 #define UHCRHDA_OCPM (1 << 11) /* Over Current Protection Mode */
70 #define UHCRHDA_POTPGT(x) \
71 (((x) & 0xff) << 24) /* Power On To Power Good Time */
73 #define UHCRHDB (0x004C) /* UHC Root Hub Descriptor B */
74 #define UHCRHS (0x0050) /* UHC Root Hub Status */
75 #define UHCRHPS1 (0x0054) /* UHC Root Hub Port 1 Status */
76 #define UHCRHPS2 (0x0058) /* UHC Root Hub Port 2 Status */
77 #define UHCRHPS3 (0x005C) /* UHC Root Hub Port 3 Status */
79 #define UHCSTAT (0x0060) /* UHC Status Register */
80 #define UHCSTAT_UPS3 (1 << 16) /* USB Power Sense Port3 */
81 #define UHCSTAT_SBMAI (1 << 15) /* System Bus Master Abort Interrupt*/
82 #define UHCSTAT_SBTAI (1 << 14) /* System Bus Target Abort Interrupt*/
83 #define UHCSTAT_UPRI (1 << 13) /* USB Port Resume Interrupt */
84 #define UHCSTAT_UPS2 (1 << 12) /* USB Power Sense Port 2 */
85 #define UHCSTAT_UPS1 (1 << 11) /* USB Power Sense Port 1 */
86 #define UHCSTAT_HTA (1 << 10) /* HCI Target Abort */
87 #define UHCSTAT_HBA (1 << 8) /* HCI Buffer Active */
88 #define UHCSTAT_RWUE (1 << 7) /* HCI Remote Wake Up Event */
90 #define UHCHR (0x0064) /* UHC Reset Register */
91 #define UHCHR_SSEP3 (1 << 11) /* Sleep Standby Enable for Port3 */
92 #define UHCHR_SSEP2 (1 << 10) /* Sleep Standby Enable for Port2 */
93 #define UHCHR_SSEP1 (1 << 9) /* Sleep Standby Enable for Port1 */
94 #define UHCHR_PCPL (1 << 7) /* Power control polarity low */
95 #define UHCHR_PSPL (1 << 6) /* Power sense polarity low */
96 #define UHCHR_SSE (1 << 5) /* Sleep Standby Enable */
97 #define UHCHR_UIT (1 << 4) /* USB Interrupt Test */
98 #define UHCHR_SSDC (1 << 3) /* Simulation Scale Down Clock */
99 #define UHCHR_CGR (1 << 2) /* Clock Generation Reset */
100 #define UHCHR_FHR (1 << 1) /* Force Host Controller Reset */
101 #define UHCHR_FSBIR (1 << 0) /* Force System Bus Iface Reset */
103 #define UHCHIE (0x0068) /* UHC Interrupt Enable Register*/
104 #define UHCHIE_UPS3IE (1 << 14) /* Power Sense Port3 IntEn */
105 #define UHCHIE_UPRIE (1 << 13) /* Port Resume IntEn */
106 #define UHCHIE_UPS2IE (1 << 12) /* Power Sense Port2 IntEn */
107 #define UHCHIE_UPS1IE (1 << 11) /* Power Sense Port1 IntEn */
108 #define UHCHIE_TAIE (1 << 10) /* HCI Interface Transfer Abort
110 #define UHCHIE_HBAIE (1 << 8) /* HCI Buffer Active IntEn */
111 #define UHCHIE_RWIE (1 << 7) /* Remote Wake-up IntEn */
113 #define UHCHIT (0x006C) /* UHC Interrupt Test register */
115 #define PXA_UHC_MAX_PORTNUM 3
117 static const char hcd_name
[] = "ohci-pxa27x";
119 static struct hc_driver __read_mostly ohci_pxa27x_hc_driver
;
123 void __iomem
*mmio_base
;
124 struct regulator
*vbus
[3];
125 bool vbus_enabled
[3];
128 #define to_pxa27x_ohci(hcd) (struct pxa27x_ohci *)(hcd_to_ohci(hcd)->priv)
131 PMM_NPS_MODE -- PMM Non-power switching mode
132 Ports are powered continuously.
134 PMM_GLOBAL_MODE -- PMM global switching mode
135 All ports are powered at the same time.
137 PMM_PERPORT_MODE -- PMM per port switching mode
138 Ports are powered individually.
140 static int pxa27x_ohci_select_pmm(struct pxa27x_ohci
*pxa_ohci
, int mode
)
142 uint32_t uhcrhda
= __raw_readl(pxa_ohci
->mmio_base
+ UHCRHDA
);
143 uint32_t uhcrhdb
= __raw_readl(pxa_ohci
->mmio_base
+ UHCRHDB
);
149 case PMM_GLOBAL_MODE
:
150 uhcrhda
&= ~(RH_A_NPS
& RH_A_PSM
);
152 case PMM_PERPORT_MODE
:
153 uhcrhda
&= ~(RH_A_NPS
);
156 /* Set port power control mask bits, only 3 ports. */
157 uhcrhdb
|= (0x7<<17);
161 "Invalid mode %d, set to non-power switch mode.\n",
167 __raw_writel(uhcrhda
, pxa_ohci
->mmio_base
+ UHCRHDA
);
168 __raw_writel(uhcrhdb
, pxa_ohci
->mmio_base
+ UHCRHDB
);
172 static int pxa27x_ohci_set_vbus_power(struct pxa27x_ohci
*pxa_ohci
,
173 unsigned int port
, bool enable
)
175 struct regulator
*vbus
= pxa_ohci
->vbus
[port
];
178 if (IS_ERR_OR_NULL(vbus
))
181 if (enable
&& !pxa_ohci
->vbus_enabled
[port
])
182 ret
= regulator_enable(vbus
);
183 else if (!enable
&& pxa_ohci
->vbus_enabled
[port
])
184 ret
= regulator_disable(vbus
);
189 pxa_ohci
->vbus_enabled
[port
] = enable
;
194 static int pxa27x_ohci_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
195 u16 wIndex
, char *buf
, u16 wLength
)
197 struct pxa27x_ohci
*pxa_ohci
= to_pxa27x_ohci(hcd
);
202 case ClearPortFeature
:
203 if (!wIndex
|| wIndex
> 3)
206 if (wValue
!= USB_PORT_FEAT_POWER
)
209 ret
= pxa27x_ohci_set_vbus_power(pxa_ohci
, wIndex
- 1,
210 typeReq
== SetPortFeature
);
216 return ohci_hub_control(hcd
, typeReq
, wValue
, wIndex
, buf
, wLength
);
218 /*-------------------------------------------------------------------------*/
220 static inline void pxa27x_setup_hc(struct pxa27x_ohci
*pxa_ohci
,
221 struct pxaohci_platform_data
*inf
)
223 uint32_t uhchr
= __raw_readl(pxa_ohci
->mmio_base
+ UHCHR
);
224 uint32_t uhcrhda
= __raw_readl(pxa_ohci
->mmio_base
+ UHCRHDA
);
226 if (inf
->flags
& ENABLE_PORT1
)
227 uhchr
&= ~UHCHR_SSEP1
;
229 if (inf
->flags
& ENABLE_PORT2
)
230 uhchr
&= ~UHCHR_SSEP2
;
232 if (inf
->flags
& ENABLE_PORT3
)
233 uhchr
&= ~UHCHR_SSEP3
;
235 if (inf
->flags
& POWER_CONTROL_LOW
)
238 if (inf
->flags
& POWER_SENSE_LOW
)
241 if (inf
->flags
& NO_OC_PROTECTION
)
242 uhcrhda
|= UHCRHDA_NOCP
;
244 uhcrhda
&= ~UHCRHDA_NOCP
;
246 if (inf
->flags
& OC_MODE_PERPORT
)
247 uhcrhda
|= UHCRHDA_OCPM
;
249 uhcrhda
&= ~UHCRHDA_OCPM
;
251 if (inf
->power_on_delay
) {
252 uhcrhda
&= ~UHCRHDA_POTPGT(0xff);
253 uhcrhda
|= UHCRHDA_POTPGT(inf
->power_on_delay
/ 2);
256 __raw_writel(uhchr
, pxa_ohci
->mmio_base
+ UHCHR
);
257 __raw_writel(uhcrhda
, pxa_ohci
->mmio_base
+ UHCRHDA
);
260 static inline void pxa27x_reset_hc(struct pxa27x_ohci
*pxa_ohci
)
262 uint32_t uhchr
= __raw_readl(pxa_ohci
->mmio_base
+ UHCHR
);
264 __raw_writel(uhchr
| UHCHR_FHR
, pxa_ohci
->mmio_base
+ UHCHR
);
266 __raw_writel(uhchr
& ~UHCHR_FHR
, pxa_ohci
->mmio_base
+ UHCHR
);
270 extern void pxa27x_clear_otgph(void);
272 #define pxa27x_clear_otgph() do {} while (0)
275 static int pxa27x_start_hc(struct pxa27x_ohci
*pxa_ohci
, struct device
*dev
)
278 struct pxaohci_platform_data
*inf
;
280 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
282 inf
= dev_get_platdata(dev
);
284 clk_prepare_enable(pxa_ohci
->clk
);
286 pxa27x_reset_hc(pxa_ohci
);
288 uhchr
= __raw_readl(pxa_ohci
->mmio_base
+ UHCHR
) | UHCHR_FSBIR
;
289 __raw_writel(uhchr
, pxa_ohci
->mmio_base
+ UHCHR
);
291 while (__raw_readl(pxa_ohci
->mmio_base
+ UHCHR
) & UHCHR_FSBIR
)
294 pxa27x_setup_hc(pxa_ohci
, inf
);
297 retval
= inf
->init(dev
);
303 pxa3xx_u2d_start_hc(&hcd
->self
);
305 uhchr
= __raw_readl(pxa_ohci
->mmio_base
+ UHCHR
) & ~UHCHR_SSE
;
306 __raw_writel(uhchr
, pxa_ohci
->mmio_base
+ UHCHR
);
307 __raw_writel(UHCHIE_UPRIE
| UHCHIE_RWIE
, pxa_ohci
->mmio_base
+ UHCHIE
);
309 /* Clear any OTG Pin Hold */
310 pxa27x_clear_otgph();
314 static void pxa27x_stop_hc(struct pxa27x_ohci
*pxa_ohci
, struct device
*dev
)
316 struct pxaohci_platform_data
*inf
;
317 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
320 inf
= dev_get_platdata(dev
);
323 pxa3xx_u2d_stop_hc(&hcd
->self
);
328 pxa27x_reset_hc(pxa_ohci
);
330 /* Host Controller Reset */
331 uhccoms
= __raw_readl(pxa_ohci
->mmio_base
+ UHCCOMS
) | 0x01;
332 __raw_writel(uhccoms
, pxa_ohci
->mmio_base
+ UHCCOMS
);
335 clk_disable_unprepare(pxa_ohci
->clk
);
339 static const struct of_device_id pxa_ohci_dt_ids
[] = {
340 { .compatible
= "marvell,pxa-ohci" },
344 MODULE_DEVICE_TABLE(of
, pxa_ohci_dt_ids
);
346 static int ohci_pxa_of_init(struct platform_device
*pdev
)
348 struct device_node
*np
= pdev
->dev
.of_node
;
349 struct pxaohci_platform_data
*pdata
;
356 /* Right now device-tree probed devices don't get dma_mask set.
357 * Since shared usb code relies on it, set it here for now.
358 * Once we have dma capability bindings this can go away.
360 ret
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
364 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
368 if (of_property_read_bool(np
, "marvell,enable-port1"))
369 pdata
->flags
|= ENABLE_PORT1
;
370 if (of_property_read_bool(np
, "marvell,enable-port2"))
371 pdata
->flags
|= ENABLE_PORT2
;
372 if (of_property_read_bool(np
, "marvell,enable-port3"))
373 pdata
->flags
|= ENABLE_PORT3
;
374 if (of_property_read_bool(np
, "marvell,port-sense-low"))
375 pdata
->flags
|= POWER_SENSE_LOW
;
376 if (of_property_read_bool(np
, "marvell,power-control-low"))
377 pdata
->flags
|= POWER_CONTROL_LOW
;
378 if (of_property_read_bool(np
, "marvell,no-oc-protection"))
379 pdata
->flags
|= NO_OC_PROTECTION
;
380 if (of_property_read_bool(np
, "marvell,oc-mode-perport"))
381 pdata
->flags
|= OC_MODE_PERPORT
;
382 if (!of_property_read_u32(np
, "marvell,power-on-delay", &tmp
))
383 pdata
->power_on_delay
= tmp
;
384 if (!of_property_read_u32(np
, "marvell,port-mode", &tmp
))
385 pdata
->port_mode
= tmp
;
386 if (!of_property_read_u32(np
, "marvell,power-budget", &tmp
))
387 pdata
->power_budget
= tmp
;
389 pdev
->dev
.platform_data
= pdata
;
394 static int ohci_pxa_of_init(struct platform_device
*pdev
)
400 /*-------------------------------------------------------------------------*/
402 /* configure so an HC device and id are always provided */
403 /* always called with process context; sleeping is OK */
407 * usb_hcd_pxa27x_probe - initialize pxa27x-based HCDs
408 * Context: !in_interrupt()
410 * Allocates basic resources for this USB host controller, and
411 * then invokes the start() method for the HCD associated with it
412 * through the hotplug entry's driver_data.
415 int usb_hcd_pxa27x_probe (const struct hc_driver
*driver
, struct platform_device
*pdev
)
419 struct pxaohci_platform_data
*inf
;
420 struct pxa27x_ohci
*pxa_ohci
;
421 struct ohci_hcd
*ohci
;
426 retval
= ohci_pxa_of_init(pdev
);
430 inf
= dev_get_platdata(&pdev
->dev
);
435 irq
= platform_get_irq(pdev
, 0);
437 pr_err("no resource of IORESOURCE_IRQ");
441 usb_clk
= devm_clk_get(&pdev
->dev
, NULL
);
443 return PTR_ERR(usb_clk
);
445 hcd
= usb_create_hcd (driver
, &pdev
->dev
, "pxa27x");
449 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
450 hcd
->regs
= devm_ioremap_resource(&pdev
->dev
, r
);
451 if (IS_ERR(hcd
->regs
)) {
452 retval
= PTR_ERR(hcd
->regs
);
455 hcd
->rsrc_start
= r
->start
;
456 hcd
->rsrc_len
= resource_size(r
);
458 /* initialize "struct pxa27x_ohci" */
459 pxa_ohci
= to_pxa27x_ohci(hcd
);
460 pxa_ohci
->clk
= usb_clk
;
461 pxa_ohci
->mmio_base
= (void __iomem
*)hcd
->regs
;
463 for (i
= 0; i
< 3; ++i
) {
466 if (!(inf
->flags
& (ENABLE_PORT1
<< i
)))
469 sprintf(name
, "vbus%u", i
+ 1);
470 pxa_ohci
->vbus
[i
] = devm_regulator_get(&pdev
->dev
, name
);
473 retval
= pxa27x_start_hc(pxa_ohci
, &pdev
->dev
);
475 pr_debug("pxa27x_start_hc failed");
479 /* Select Power Management Mode */
480 pxa27x_ohci_select_pmm(pxa_ohci
, inf
->port_mode
);
482 if (inf
->power_budget
)
483 hcd
->power_budget
= inf
->power_budget
;
485 /* The value of NDP in roothub_a is incorrect on this hardware */
486 ohci
= hcd_to_ohci(hcd
);
489 retval
= usb_add_hcd(hcd
, irq
, 0);
491 device_wakeup_enable(hcd
->self
.controller
);
495 pxa27x_stop_hc(pxa_ohci
, &pdev
->dev
);
502 /* may be called without controller electrically present */
503 /* may be called with controller, bus, and devices active */
506 * usb_hcd_pxa27x_remove - shutdown processing for pxa27x-based HCDs
507 * @dev: USB Host Controller being removed
508 * Context: !in_interrupt()
510 * Reverses the effect of usb_hcd_pxa27x_probe(), first invoking
511 * the HCD's stop() method. It is always called from a thread
512 * context, normally "rmmod", "apmd", or something similar.
515 void usb_hcd_pxa27x_remove (struct usb_hcd
*hcd
, struct platform_device
*pdev
)
517 struct pxa27x_ohci
*pxa_ohci
= to_pxa27x_ohci(hcd
);
521 pxa27x_stop_hc(pxa_ohci
, &pdev
->dev
);
523 for (i
= 0; i
< 3; ++i
)
524 pxa27x_ohci_set_vbus_power(pxa_ohci
, i
, false);
529 /*-------------------------------------------------------------------------*/
531 static int ohci_hcd_pxa27x_drv_probe(struct platform_device
*pdev
)
533 pr_debug ("In ohci_hcd_pxa27x_drv_probe");
538 return usb_hcd_pxa27x_probe(&ohci_pxa27x_hc_driver
, pdev
);
541 static int ohci_hcd_pxa27x_drv_remove(struct platform_device
*pdev
)
543 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
545 usb_hcd_pxa27x_remove(hcd
, pdev
);
550 static int ohci_hcd_pxa27x_drv_suspend(struct device
*dev
)
552 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
553 struct pxa27x_ohci
*pxa_ohci
= to_pxa27x_ohci(hcd
);
554 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
555 bool do_wakeup
= device_may_wakeup(dev
);
559 if (time_before(jiffies
, ohci
->next_statechange
))
561 ohci
->next_statechange
= jiffies
;
563 ret
= ohci_suspend(hcd
, do_wakeup
);
567 pxa27x_stop_hc(pxa_ohci
, dev
);
571 static int ohci_hcd_pxa27x_drv_resume(struct device
*dev
)
573 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
574 struct pxa27x_ohci
*pxa_ohci
= to_pxa27x_ohci(hcd
);
575 struct pxaohci_platform_data
*inf
= dev_get_platdata(dev
);
576 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
579 if (time_before(jiffies
, ohci
->next_statechange
))
581 ohci
->next_statechange
= jiffies
;
583 status
= pxa27x_start_hc(pxa_ohci
, dev
);
587 /* Select Power Management Mode */
588 pxa27x_ohci_select_pmm(pxa_ohci
, inf
->port_mode
);
590 ohci_resume(hcd
, false);
594 static const struct dev_pm_ops ohci_hcd_pxa27x_pm_ops
= {
595 .suspend
= ohci_hcd_pxa27x_drv_suspend
,
596 .resume
= ohci_hcd_pxa27x_drv_resume
,
600 static struct platform_driver ohci_hcd_pxa27x_driver
= {
601 .probe
= ohci_hcd_pxa27x_drv_probe
,
602 .remove
= ohci_hcd_pxa27x_drv_remove
,
603 .shutdown
= usb_hcd_platform_shutdown
,
605 .name
= "pxa27x-ohci",
606 .of_match_table
= of_match_ptr(pxa_ohci_dt_ids
),
608 .pm
= &ohci_hcd_pxa27x_pm_ops
,
613 static const struct ohci_driver_overrides pxa27x_overrides __initconst
= {
614 .extra_priv_size
= sizeof(struct pxa27x_ohci
),
617 static int __init
ohci_pxa27x_init(void)
622 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
624 ohci_init_driver(&ohci_pxa27x_hc_driver
, &pxa27x_overrides
);
625 ohci_pxa27x_hc_driver
.hub_control
= pxa27x_ohci_hub_control
;
627 return platform_driver_register(&ohci_hcd_pxa27x_driver
);
629 module_init(ohci_pxa27x_init
);
631 static void __exit
ohci_pxa27x_cleanup(void)
633 platform_driver_unregister(&ohci_hcd_pxa27x_driver
);
635 module_exit(ohci_pxa27x_cleanup
);
637 MODULE_DESCRIPTION(DRIVER_DESC
);
638 MODULE_LICENSE("GPL");
639 MODULE_ALIAS("platform:pxa27x-ohci");