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/device.h>
23 #include <linux/signal.h>
24 #include <linux/platform_device.h>
25 #include <linux/clk.h>
26 #include <linux/of_platform.h>
27 #include <linux/of_gpio.h>
28 #include <mach/hardware.h>
29 #include <linux/platform_data/usb-ohci-pxa27x.h>
30 #include <linux/platform_data/usb-pxa3xx-ulpi.h>
33 * UHC: USB Host Controller (OHCI-like) register definitions
35 #define UHCREV (0x0000) /* UHC HCI Spec Revision */
36 #define UHCHCON (0x0004) /* UHC Host Control Register */
37 #define UHCCOMS (0x0008) /* UHC Command Status Register */
38 #define UHCINTS (0x000C) /* UHC Interrupt Status Register */
39 #define UHCINTE (0x0010) /* UHC Interrupt Enable */
40 #define UHCINTD (0x0014) /* UHC Interrupt Disable */
41 #define UHCHCCA (0x0018) /* UHC Host Controller Comm. Area */
42 #define UHCPCED (0x001C) /* UHC Period Current Endpt Descr */
43 #define UHCCHED (0x0020) /* UHC Control Head Endpt Descr */
44 #define UHCCCED (0x0024) /* UHC Control Current Endpt Descr */
45 #define UHCBHED (0x0028) /* UHC Bulk Head Endpt Descr */
46 #define UHCBCED (0x002C) /* UHC Bulk Current Endpt Descr */
47 #define UHCDHEAD (0x0030) /* UHC Done Head */
48 #define UHCFMI (0x0034) /* UHC Frame Interval */
49 #define UHCFMR (0x0038) /* UHC Frame Remaining */
50 #define UHCFMN (0x003C) /* UHC Frame Number */
51 #define UHCPERS (0x0040) /* UHC Periodic Start */
52 #define UHCLS (0x0044) /* UHC Low Speed Threshold */
54 #define UHCRHDA (0x0048) /* UHC Root Hub Descriptor A */
55 #define UHCRHDA_NOCP (1 << 12) /* No over current protection */
56 #define UHCRHDA_OCPM (1 << 11) /* Over Current Protection Mode */
57 #define UHCRHDA_POTPGT(x) \
58 (((x) & 0xff) << 24) /* Power On To Power Good Time */
60 #define UHCRHDB (0x004C) /* UHC Root Hub Descriptor B */
61 #define UHCRHS (0x0050) /* UHC Root Hub Status */
62 #define UHCRHPS1 (0x0054) /* UHC Root Hub Port 1 Status */
63 #define UHCRHPS2 (0x0058) /* UHC Root Hub Port 2 Status */
64 #define UHCRHPS3 (0x005C) /* UHC Root Hub Port 3 Status */
66 #define UHCSTAT (0x0060) /* UHC Status Register */
67 #define UHCSTAT_UPS3 (1 << 16) /* USB Power Sense Port3 */
68 #define UHCSTAT_SBMAI (1 << 15) /* System Bus Master Abort Interrupt*/
69 #define UHCSTAT_SBTAI (1 << 14) /* System Bus Target Abort Interrupt*/
70 #define UHCSTAT_UPRI (1 << 13) /* USB Port Resume Interrupt */
71 #define UHCSTAT_UPS2 (1 << 12) /* USB Power Sense Port 2 */
72 #define UHCSTAT_UPS1 (1 << 11) /* USB Power Sense Port 1 */
73 #define UHCSTAT_HTA (1 << 10) /* HCI Target Abort */
74 #define UHCSTAT_HBA (1 << 8) /* HCI Buffer Active */
75 #define UHCSTAT_RWUE (1 << 7) /* HCI Remote Wake Up Event */
77 #define UHCHR (0x0064) /* UHC Reset Register */
78 #define UHCHR_SSEP3 (1 << 11) /* Sleep Standby Enable for Port3 */
79 #define UHCHR_SSEP2 (1 << 10) /* Sleep Standby Enable for Port2 */
80 #define UHCHR_SSEP1 (1 << 9) /* Sleep Standby Enable for Port1 */
81 #define UHCHR_PCPL (1 << 7) /* Power control polarity low */
82 #define UHCHR_PSPL (1 << 6) /* Power sense polarity low */
83 #define UHCHR_SSE (1 << 5) /* Sleep Standby Enable */
84 #define UHCHR_UIT (1 << 4) /* USB Interrupt Test */
85 #define UHCHR_SSDC (1 << 3) /* Simulation Scale Down Clock */
86 #define UHCHR_CGR (1 << 2) /* Clock Generation Reset */
87 #define UHCHR_FHR (1 << 1) /* Force Host Controller Reset */
88 #define UHCHR_FSBIR (1 << 0) /* Force System Bus Iface Reset */
90 #define UHCHIE (0x0068) /* UHC Interrupt Enable Register*/
91 #define UHCHIE_UPS3IE (1 << 14) /* Power Sense Port3 IntEn */
92 #define UHCHIE_UPRIE (1 << 13) /* Port Resume IntEn */
93 #define UHCHIE_UPS2IE (1 << 12) /* Power Sense Port2 IntEn */
94 #define UHCHIE_UPS1IE (1 << 11) /* Power Sense Port1 IntEn */
95 #define UHCHIE_TAIE (1 << 10) /* HCI Interface Transfer Abort
97 #define UHCHIE_HBAIE (1 << 8) /* HCI Buffer Active IntEn */
98 #define UHCHIE_RWIE (1 << 7) /* Remote Wake-up IntEn */
100 #define UHCHIT (0x006C) /* UHC Interrupt Test register */
102 #define PXA_UHC_MAX_PORTNUM 3
105 /* must be 1st member here for hcd_to_ohci() to work */
106 struct ohci_hcd ohci
;
110 void __iomem
*mmio_base
;
113 #define to_pxa27x_ohci(hcd) (struct pxa27x_ohci *)hcd_to_ohci(hcd)
116 PMM_NPS_MODE -- PMM Non-power switching mode
117 Ports are powered continuously.
119 PMM_GLOBAL_MODE -- PMM global switching mode
120 All ports are powered at the same time.
122 PMM_PERPORT_MODE -- PMM per port switching mode
123 Ports are powered individually.
125 static int pxa27x_ohci_select_pmm(struct pxa27x_ohci
*ohci
, int mode
)
127 uint32_t uhcrhda
= __raw_readl(ohci
->mmio_base
+ UHCRHDA
);
128 uint32_t uhcrhdb
= __raw_readl(ohci
->mmio_base
+ UHCRHDB
);
134 case PMM_GLOBAL_MODE
:
135 uhcrhda
&= ~(RH_A_NPS
& RH_A_PSM
);
137 case PMM_PERPORT_MODE
:
138 uhcrhda
&= ~(RH_A_NPS
);
141 /* Set port power control mask bits, only 3 ports. */
142 uhcrhdb
|= (0x7<<17);
146 "Invalid mode %d, set to non-power switch mode.\n",
152 __raw_writel(uhcrhda
, ohci
->mmio_base
+ UHCRHDA
);
153 __raw_writel(uhcrhdb
, ohci
->mmio_base
+ UHCRHDB
);
157 extern int usb_disabled(void);
159 /*-------------------------------------------------------------------------*/
161 static inline void pxa27x_setup_hc(struct pxa27x_ohci
*ohci
,
162 struct pxaohci_platform_data
*inf
)
164 uint32_t uhchr
= __raw_readl(ohci
->mmio_base
+ UHCHR
);
165 uint32_t uhcrhda
= __raw_readl(ohci
->mmio_base
+ UHCRHDA
);
167 if (inf
->flags
& ENABLE_PORT1
)
168 uhchr
&= ~UHCHR_SSEP1
;
170 if (inf
->flags
& ENABLE_PORT2
)
171 uhchr
&= ~UHCHR_SSEP2
;
173 if (inf
->flags
& ENABLE_PORT3
)
174 uhchr
&= ~UHCHR_SSEP3
;
176 if (inf
->flags
& POWER_CONTROL_LOW
)
179 if (inf
->flags
& POWER_SENSE_LOW
)
182 if (inf
->flags
& NO_OC_PROTECTION
)
183 uhcrhda
|= UHCRHDA_NOCP
;
185 uhcrhda
&= ~UHCRHDA_NOCP
;
187 if (inf
->flags
& OC_MODE_PERPORT
)
188 uhcrhda
|= UHCRHDA_OCPM
;
190 uhcrhda
&= ~UHCRHDA_OCPM
;
192 if (inf
->power_on_delay
) {
193 uhcrhda
&= ~UHCRHDA_POTPGT(0xff);
194 uhcrhda
|= UHCRHDA_POTPGT(inf
->power_on_delay
/ 2);
197 __raw_writel(uhchr
, ohci
->mmio_base
+ UHCHR
);
198 __raw_writel(uhcrhda
, ohci
->mmio_base
+ UHCRHDA
);
201 static inline void pxa27x_reset_hc(struct pxa27x_ohci
*ohci
)
203 uint32_t uhchr
= __raw_readl(ohci
->mmio_base
+ UHCHR
);
205 __raw_writel(uhchr
| UHCHR_FHR
, ohci
->mmio_base
+ UHCHR
);
207 __raw_writel(uhchr
& ~UHCHR_FHR
, ohci
->mmio_base
+ UHCHR
);
211 extern void pxa27x_clear_otgph(void);
213 #define pxa27x_clear_otgph() do {} while (0)
216 static int pxa27x_start_hc(struct pxa27x_ohci
*ohci
, struct device
*dev
)
219 struct pxaohci_platform_data
*inf
;
222 inf
= dev_get_platdata(dev
);
224 clk_prepare_enable(ohci
->clk
);
226 pxa27x_reset_hc(ohci
);
228 uhchr
= __raw_readl(ohci
->mmio_base
+ UHCHR
) | UHCHR_FSBIR
;
229 __raw_writel(uhchr
, ohci
->mmio_base
+ UHCHR
);
231 while (__raw_readl(ohci
->mmio_base
+ UHCHR
) & UHCHR_FSBIR
)
234 pxa27x_setup_hc(ohci
, inf
);
237 retval
= inf
->init(dev
);
243 pxa3xx_u2d_start_hc(&ohci_to_hcd(&ohci
->ohci
)->self
);
245 uhchr
= __raw_readl(ohci
->mmio_base
+ UHCHR
) & ~UHCHR_SSE
;
246 __raw_writel(uhchr
, ohci
->mmio_base
+ UHCHR
);
247 __raw_writel(UHCHIE_UPRIE
| UHCHIE_RWIE
, ohci
->mmio_base
+ UHCHIE
);
249 /* Clear any OTG Pin Hold */
250 pxa27x_clear_otgph();
254 static void pxa27x_stop_hc(struct pxa27x_ohci
*ohci
, struct device
*dev
)
256 struct pxaohci_platform_data
*inf
;
259 inf
= dev_get_platdata(dev
);
262 pxa3xx_u2d_stop_hc(&ohci_to_hcd(&ohci
->ohci
)->self
);
267 pxa27x_reset_hc(ohci
);
269 /* Host Controller Reset */
270 uhccoms
= __raw_readl(ohci
->mmio_base
+ UHCCOMS
) | 0x01;
271 __raw_writel(uhccoms
, ohci
->mmio_base
+ UHCCOMS
);
274 clk_disable_unprepare(ohci
->clk
);
278 static const struct of_device_id pxa_ohci_dt_ids
[] = {
279 { .compatible
= "marvell,pxa-ohci" },
283 MODULE_DEVICE_TABLE(of
, pxa_ohci_dt_ids
);
285 static int ohci_pxa_of_init(struct platform_device
*pdev
)
287 struct device_node
*np
= pdev
->dev
.of_node
;
288 struct pxaohci_platform_data
*pdata
;
294 /* Right now device-tree probed devices don't get dma_mask set.
295 * Since shared usb code relies on it, set it here for now.
296 * Once we have dma capability bindings this can go away.
298 if (!pdev
->dev
.dma_mask
)
299 pdev
->dev
.dma_mask
= &pdev
->dev
.coherent_dma_mask
;
300 if (!pdev
->dev
.coherent_dma_mask
)
301 pdev
->dev
.coherent_dma_mask
= DMA_BIT_MASK(32);
303 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
307 if (of_get_property(np
, "marvell,enable-port1", NULL
))
308 pdata
->flags
|= ENABLE_PORT1
;
309 if (of_get_property(np
, "marvell,enable-port2", NULL
))
310 pdata
->flags
|= ENABLE_PORT2
;
311 if (of_get_property(np
, "marvell,enable-port3", NULL
))
312 pdata
->flags
|= ENABLE_PORT3
;
313 if (of_get_property(np
, "marvell,port-sense-low", NULL
))
314 pdata
->flags
|= POWER_SENSE_LOW
;
315 if (of_get_property(np
, "marvell,power-control-low", NULL
))
316 pdata
->flags
|= POWER_CONTROL_LOW
;
317 if (of_get_property(np
, "marvell,no-oc-protection", NULL
))
318 pdata
->flags
|= NO_OC_PROTECTION
;
319 if (of_get_property(np
, "marvell,oc-mode-perport", NULL
))
320 pdata
->flags
|= OC_MODE_PERPORT
;
321 if (!of_property_read_u32(np
, "marvell,power-on-delay", &tmp
))
322 pdata
->power_on_delay
= tmp
;
323 if (!of_property_read_u32(np
, "marvell,port-mode", &tmp
))
324 pdata
->port_mode
= tmp
;
325 if (!of_property_read_u32(np
, "marvell,power-budget", &tmp
))
326 pdata
->power_budget
= tmp
;
328 pdev
->dev
.platform_data
= pdata
;
333 static int ohci_pxa_of_init(struct platform_device
*pdev
)
339 /*-------------------------------------------------------------------------*/
341 /* configure so an HC device and id are always provided */
342 /* always called with process context; sleeping is OK */
346 * usb_hcd_pxa27x_probe - initialize pxa27x-based HCDs
347 * Context: !in_interrupt()
349 * Allocates basic resources for this USB host controller, and
350 * then invokes the start() method for the HCD associated with it
351 * through the hotplug entry's driver_data.
354 int usb_hcd_pxa27x_probe (const struct hc_driver
*driver
, struct platform_device
*pdev
)
358 struct pxaohci_platform_data
*inf
;
359 struct pxa27x_ohci
*ohci
;
363 retval
= ohci_pxa_of_init(pdev
);
367 inf
= dev_get_platdata(&pdev
->dev
);
372 irq
= platform_get_irq(pdev
, 0);
374 pr_err("no resource of IORESOURCE_IRQ");
378 usb_clk
= clk_get(&pdev
->dev
, NULL
);
380 return PTR_ERR(usb_clk
);
382 hcd
= usb_create_hcd (driver
, &pdev
->dev
, "pxa27x");
388 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
390 pr_err("no resource of IORESOURCE_MEM");
395 hcd
->rsrc_start
= r
->start
;
396 hcd
->rsrc_len
= resource_size(r
);
398 if (!request_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
, hcd_name
)) {
399 pr_debug("request_mem_region failed");
404 hcd
->regs
= ioremap(hcd
->rsrc_start
, hcd
->rsrc_len
);
406 pr_debug("ioremap failed");
411 /* initialize "struct pxa27x_ohci" */
412 ohci
= (struct pxa27x_ohci
*)hcd_to_ohci(hcd
);
413 ohci
->dev
= &pdev
->dev
;
415 ohci
->mmio_base
= (void __iomem
*)hcd
->regs
;
417 if ((retval
= pxa27x_start_hc(ohci
, &pdev
->dev
)) < 0) {
418 pr_debug("pxa27x_start_hc failed");
422 /* Select Power Management Mode */
423 pxa27x_ohci_select_pmm(ohci
, inf
->port_mode
);
425 if (inf
->power_budget
)
426 hcd
->power_budget
= inf
->power_budget
;
428 ohci_hcd_init(hcd_to_ohci(hcd
));
430 retval
= usb_add_hcd(hcd
, irq
, 0);
434 pxa27x_stop_hc(ohci
, &pdev
->dev
);
438 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
447 /* may be called without controller electrically present */
448 /* may be called with controller, bus, and devices active */
451 * usb_hcd_pxa27x_remove - shutdown processing for pxa27x-based HCDs
452 * @dev: USB Host Controller being removed
453 * Context: !in_interrupt()
455 * Reverses the effect of usb_hcd_pxa27x_probe(), first invoking
456 * the HCD's stop() method. It is always called from a thread
457 * context, normally "rmmod", "apmd", or something similar.
460 void usb_hcd_pxa27x_remove (struct usb_hcd
*hcd
, struct platform_device
*pdev
)
462 struct pxa27x_ohci
*ohci
= to_pxa27x_ohci(hcd
);
465 pxa27x_stop_hc(ohci
, &pdev
->dev
);
467 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
472 /*-------------------------------------------------------------------------*/
475 ohci_pxa27x_start (struct usb_hcd
*hcd
)
477 struct ohci_hcd
*ohci
= hcd_to_ohci (hcd
);
480 ohci_dbg (ohci
, "ohci_pxa27x_start, ohci:%p", ohci
);
482 /* The value of NDP in roothub_a is incorrect on this hardware */
485 if ((ret
= ohci_init(ohci
)) < 0)
488 if ((ret
= ohci_run (ohci
)) < 0) {
489 dev_err(hcd
->self
.controller
, "can't start %s",
498 /*-------------------------------------------------------------------------*/
500 static const struct hc_driver ohci_pxa27x_hc_driver
= {
501 .description
= hcd_name
,
502 .product_desc
= "PXA27x OHCI",
503 .hcd_priv_size
= sizeof(struct pxa27x_ohci
),
506 * generic hardware linkage
509 .flags
= HCD_USB11
| HCD_MEMORY
,
512 * basic lifecycle operations
514 .start
= ohci_pxa27x_start
,
516 .shutdown
= ohci_shutdown
,
519 * managing i/o requests and associated device resources
521 .urb_enqueue
= ohci_urb_enqueue
,
522 .urb_dequeue
= ohci_urb_dequeue
,
523 .endpoint_disable
= ohci_endpoint_disable
,
528 .get_frame_number
= ohci_get_frame
,
533 .hub_status_data
= ohci_hub_status_data
,
534 .hub_control
= ohci_hub_control
,
536 .bus_suspend
= ohci_bus_suspend
,
537 .bus_resume
= ohci_bus_resume
,
539 .start_port_reset
= ohci_start_port_reset
,
542 /*-------------------------------------------------------------------------*/
544 static int ohci_hcd_pxa27x_drv_probe(struct platform_device
*pdev
)
546 pr_debug ("In ohci_hcd_pxa27x_drv_probe");
551 return usb_hcd_pxa27x_probe(&ohci_pxa27x_hc_driver
, pdev
);
554 static int ohci_hcd_pxa27x_drv_remove(struct platform_device
*pdev
)
556 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
558 usb_hcd_pxa27x_remove(hcd
, pdev
);
563 static int ohci_hcd_pxa27x_drv_suspend(struct device
*dev
)
565 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
566 struct pxa27x_ohci
*ohci
= to_pxa27x_ohci(hcd
);
568 if (time_before(jiffies
, ohci
->ohci
.next_statechange
))
570 ohci
->ohci
.next_statechange
= jiffies
;
572 pxa27x_stop_hc(ohci
, dev
);
576 static int ohci_hcd_pxa27x_drv_resume(struct device
*dev
)
578 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
579 struct pxa27x_ohci
*ohci
= to_pxa27x_ohci(hcd
);
580 struct pxaohci_platform_data
*inf
= dev_get_platdata(dev
);
583 if (time_before(jiffies
, ohci
->ohci
.next_statechange
))
585 ohci
->ohci
.next_statechange
= jiffies
;
587 if ((status
= pxa27x_start_hc(ohci
, dev
)) < 0)
590 /* Select Power Management Mode */
591 pxa27x_ohci_select_pmm(ohci
, inf
->port_mode
);
593 ohci_resume(hcd
, false);
597 static const struct dev_pm_ops ohci_hcd_pxa27x_pm_ops
= {
598 .suspend
= ohci_hcd_pxa27x_drv_suspend
,
599 .resume
= ohci_hcd_pxa27x_drv_resume
,
603 /* work with hotplug and coldplug */
604 MODULE_ALIAS("platform:pxa27x-ohci");
606 static struct platform_driver ohci_hcd_pxa27x_driver
= {
607 .probe
= ohci_hcd_pxa27x_drv_probe
,
608 .remove
= ohci_hcd_pxa27x_drv_remove
,
609 .shutdown
= usb_hcd_platform_shutdown
,
611 .name
= "pxa27x-ohci",
612 .owner
= THIS_MODULE
,
613 .of_match_table
= of_match_ptr(pxa_ohci_dt_ids
),
615 .pm
= &ohci_hcd_pxa27x_pm_ops
,