1 // SPDX-License-Identifier: GPL-1.0+
3 * OHCI HCD (Host Controller Driver) for USB.
7 * (C) Copyright 2002 Hewlett-Packard Company
12 * Based on fragments of previous driver by Russell King et al.
14 * Modified for LH7A404 from ohci-sa1111.c
17 * Modified for pxa27x from ohci-lh7a404.c
20 * This file is licenced under the GPL.
23 #include <linux/clk.h>
24 #include <linux/device.h>
25 #include <linux/dma-mapping.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/of_platform.h>
30 #include <linux/of_gpio.h>
31 #include <linux/platform_data/usb-ohci-pxa27x.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>
38 #include <linux/soc/pxa/cpu.h>
42 #define DRIVER_DESC "OHCI PXA27x/PXA3x driver"
45 * UHC: USB Host Controller (OHCI-like) register definitions
47 #define UHCREV (0x0000) /* UHC HCI Spec Revision */
48 #define UHCHCON (0x0004) /* UHC Host Control Register */
49 #define UHCCOMS (0x0008) /* UHC Command Status Register */
50 #define UHCINTS (0x000C) /* UHC Interrupt Status Register */
51 #define UHCINTE (0x0010) /* UHC Interrupt Enable */
52 #define UHCINTD (0x0014) /* UHC Interrupt Disable */
53 #define UHCHCCA (0x0018) /* UHC Host Controller Comm. Area */
54 #define UHCPCED (0x001C) /* UHC Period Current Endpt Descr */
55 #define UHCCHED (0x0020) /* UHC Control Head Endpt Descr */
56 #define UHCCCED (0x0024) /* UHC Control Current Endpt Descr */
57 #define UHCBHED (0x0028) /* UHC Bulk Head Endpt Descr */
58 #define UHCBCED (0x002C) /* UHC Bulk Current Endpt Descr */
59 #define UHCDHEAD (0x0030) /* UHC Done Head */
60 #define UHCFMI (0x0034) /* UHC Frame Interval */
61 #define UHCFMR (0x0038) /* UHC Frame Remaining */
62 #define UHCFMN (0x003C) /* UHC Frame Number */
63 #define UHCPERS (0x0040) /* UHC Periodic Start */
64 #define UHCLS (0x0044) /* UHC Low Speed Threshold */
66 #define UHCRHDA (0x0048) /* UHC Root Hub Descriptor A */
67 #define UHCRHDA_NOCP (1 << 12) /* No over current protection */
68 #define UHCRHDA_OCPM (1 << 11) /* Over Current Protection Mode */
69 #define UHCRHDA_POTPGT(x) \
70 (((x) & 0xff) << 24) /* Power On To Power Good Time */
72 #define UHCRHDB (0x004C) /* UHC Root Hub Descriptor B */
73 #define UHCRHS (0x0050) /* UHC Root Hub Status */
74 #define UHCRHPS1 (0x0054) /* UHC Root Hub Port 1 Status */
75 #define UHCRHPS2 (0x0058) /* UHC Root Hub Port 2 Status */
76 #define UHCRHPS3 (0x005C) /* UHC Root Hub Port 3 Status */
78 #define UHCSTAT (0x0060) /* UHC Status Register */
79 #define UHCSTAT_UPS3 (1 << 16) /* USB Power Sense Port3 */
80 #define UHCSTAT_SBMAI (1 << 15) /* System Bus Master Abort Interrupt*/
81 #define UHCSTAT_SBTAI (1 << 14) /* System Bus Target Abort Interrupt*/
82 #define UHCSTAT_UPRI (1 << 13) /* USB Port Resume Interrupt */
83 #define UHCSTAT_UPS2 (1 << 12) /* USB Power Sense Port 2 */
84 #define UHCSTAT_UPS1 (1 << 11) /* USB Power Sense Port 1 */
85 #define UHCSTAT_HTA (1 << 10) /* HCI Target Abort */
86 #define UHCSTAT_HBA (1 << 8) /* HCI Buffer Active */
87 #define UHCSTAT_RWUE (1 << 7) /* HCI Remote Wake Up Event */
89 #define UHCHR (0x0064) /* UHC Reset Register */
90 #define UHCHR_SSEP3 (1 << 11) /* Sleep Standby Enable for Port3 */
91 #define UHCHR_SSEP2 (1 << 10) /* Sleep Standby Enable for Port2 */
92 #define UHCHR_SSEP1 (1 << 9) /* Sleep Standby Enable for Port1 */
93 #define UHCHR_PCPL (1 << 7) /* Power control polarity low */
94 #define UHCHR_PSPL (1 << 6) /* Power sense polarity low */
95 #define UHCHR_SSE (1 << 5) /* Sleep Standby Enable */
96 #define UHCHR_UIT (1 << 4) /* USB Interrupt Test */
97 #define UHCHR_SSDC (1 << 3) /* Simulation Scale Down Clock */
98 #define UHCHR_CGR (1 << 2) /* Clock Generation Reset */
99 #define UHCHR_FHR (1 << 1) /* Force Host Controller Reset */
100 #define UHCHR_FSBIR (1 << 0) /* Force System Bus Iface Reset */
102 #define UHCHIE (0x0068) /* UHC Interrupt Enable Register*/
103 #define UHCHIE_UPS3IE (1 << 14) /* Power Sense Port3 IntEn */
104 #define UHCHIE_UPRIE (1 << 13) /* Port Resume IntEn */
105 #define UHCHIE_UPS2IE (1 << 12) /* Power Sense Port2 IntEn */
106 #define UHCHIE_UPS1IE (1 << 11) /* Power Sense Port1 IntEn */
107 #define UHCHIE_TAIE (1 << 10) /* HCI Interface Transfer Abort
109 #define UHCHIE_HBAIE (1 << 8) /* HCI Buffer Active IntEn */
110 #define UHCHIE_RWIE (1 << 7) /* Remote Wake-up IntEn */
112 #define UHCHIT (0x006C) /* UHC Interrupt Test register */
114 #define PXA_UHC_MAX_PORTNUM 3
116 static struct hc_driver __read_mostly ohci_pxa27x_hc_driver;
120 void __iomem *mmio_base;
121 struct regulator *vbus[3];
122 bool vbus_enabled[3];
125 #define to_pxa27x_ohci(hcd) (struct pxa27x_ohci *)(hcd_to_ohci(hcd)->priv)
128 PMM_NPS_MODE -- PMM Non-power switching mode
129 Ports are powered continuously.
131 PMM_GLOBAL_MODE -- PMM global switching mode
132 All ports are powered at the same time.
134 PMM_PERPORT_MODE -- PMM per port switching mode
135 Ports are powered individually.
137 static int pxa27x_ohci_select_pmm(struct pxa27x_ohci *pxa_ohci, int mode)
139 uint32_t uhcrhda = __raw_readl(pxa_ohci->mmio_base + UHCRHDA);
140 uint32_t uhcrhdb = __raw_readl(pxa_ohci->mmio_base + UHCRHDB);
146 case PMM_GLOBAL_MODE:
147 uhcrhda &= ~(RH_A_NPS | RH_A_PSM);
149 case PMM_PERPORT_MODE:
150 uhcrhda &= ~(RH_A_NPS);
153 /* Set port power control mask bits, only 3 ports. */
154 uhcrhdb |= (0x7<<17);
158 "Invalid mode %d, set to non-power switch mode.\n",
164 __raw_writel(uhcrhda, pxa_ohci->mmio_base + UHCRHDA);
165 __raw_writel(uhcrhdb, pxa_ohci->mmio_base + UHCRHDB);
169 static int pxa27x_ohci_set_vbus_power(struct pxa27x_ohci *pxa_ohci,
170 unsigned int port, bool enable)
172 struct regulator *vbus = pxa_ohci->vbus[port];
175 if (IS_ERR_OR_NULL(vbus))
178 if (enable && !pxa_ohci->vbus_enabled[port])
179 ret = regulator_enable(vbus);
180 else if (!enable && pxa_ohci->vbus_enabled[port])
181 ret = regulator_disable(vbus);
186 pxa_ohci->vbus_enabled[port] = enable;
191 static int pxa27x_ohci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
192 u16 wIndex, char *buf, u16 wLength)
194 struct pxa27x_ohci *pxa_ohci = to_pxa27x_ohci(hcd);
199 case ClearPortFeature:
200 if (!wIndex || wIndex > 3)
203 if (wValue != USB_PORT_FEAT_POWER)
206 ret = pxa27x_ohci_set_vbus_power(pxa_ohci, wIndex - 1,
207 typeReq == SetPortFeature);
213 return ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
215 /*-------------------------------------------------------------------------*/
217 static inline void pxa27x_setup_hc(struct pxa27x_ohci *pxa_ohci,
218 struct pxaohci_platform_data *inf)
220 uint32_t uhchr = __raw_readl(pxa_ohci->mmio_base + UHCHR);
221 uint32_t uhcrhda = __raw_readl(pxa_ohci->mmio_base + UHCRHDA);
223 if (inf->flags & ENABLE_PORT1)
224 uhchr &= ~UHCHR_SSEP1;
226 if (inf->flags & ENABLE_PORT2)
227 uhchr &= ~UHCHR_SSEP2;
229 if (inf->flags & ENABLE_PORT3)
230 uhchr &= ~UHCHR_SSEP3;
232 if (inf->flags & POWER_CONTROL_LOW)
235 if (inf->flags & POWER_SENSE_LOW)
238 if (inf->flags & NO_OC_PROTECTION)
239 uhcrhda |= UHCRHDA_NOCP;
241 uhcrhda &= ~UHCRHDA_NOCP;
243 if (inf->flags & OC_MODE_PERPORT)
244 uhcrhda |= UHCRHDA_OCPM;
246 uhcrhda &= ~UHCRHDA_OCPM;
248 if (inf->power_on_delay) {
249 uhcrhda &= ~UHCRHDA_POTPGT(0xff);
250 uhcrhda |= UHCRHDA_POTPGT(inf->power_on_delay / 2);
253 __raw_writel(uhchr, pxa_ohci->mmio_base + UHCHR);
254 __raw_writel(uhcrhda, pxa_ohci->mmio_base + UHCRHDA);
257 static inline void pxa27x_reset_hc(struct pxa27x_ohci *pxa_ohci)
259 uint32_t uhchr = __raw_readl(pxa_ohci->mmio_base + UHCHR);
261 __raw_writel(uhchr | UHCHR_FHR, pxa_ohci->mmio_base + UHCHR);
263 __raw_writel(uhchr & ~UHCHR_FHR, pxa_ohci->mmio_base + UHCHR);
267 extern void pxa27x_clear_otgph(void);
269 #define pxa27x_clear_otgph() do {} while (0)
272 static int pxa27x_start_hc(struct pxa27x_ohci *pxa_ohci, struct device *dev)
275 struct pxaohci_platform_data *inf;
278 inf = dev_get_platdata(dev);
280 retval = clk_prepare_enable(pxa_ohci->clk);
284 pxa27x_reset_hc(pxa_ohci);
286 uhchr = __raw_readl(pxa_ohci->mmio_base + UHCHR) | UHCHR_FSBIR;
287 __raw_writel(uhchr, pxa_ohci->mmio_base + UHCHR);
289 while (__raw_readl(pxa_ohci->mmio_base + UHCHR) & UHCHR_FSBIR)
292 pxa27x_setup_hc(pxa_ohci, inf);
295 retval = inf->init(dev);
298 clk_disable_unprepare(pxa_ohci->clk);
302 uhchr = __raw_readl(pxa_ohci->mmio_base + UHCHR) & ~UHCHR_SSE;
303 __raw_writel(uhchr, pxa_ohci->mmio_base + UHCHR);
304 __raw_writel(UHCHIE_UPRIE | UHCHIE_RWIE, pxa_ohci->mmio_base + UHCHIE);
306 /* Clear any OTG Pin Hold */
307 pxa27x_clear_otgph();
311 static void pxa27x_stop_hc(struct pxa27x_ohci *pxa_ohci, struct device *dev)
313 struct pxaohci_platform_data *inf;
316 inf = dev_get_platdata(dev);
321 pxa27x_reset_hc(pxa_ohci);
323 /* Host Controller Reset */
324 uhccoms = __raw_readl(pxa_ohci->mmio_base + UHCCOMS) | 0x01;
325 __raw_writel(uhccoms, pxa_ohci->mmio_base + UHCCOMS);
328 clk_disable_unprepare(pxa_ohci->clk);
332 static const struct of_device_id pxa_ohci_dt_ids[] = {
333 { .compatible = "marvell,pxa-ohci" },
337 MODULE_DEVICE_TABLE(of, pxa_ohci_dt_ids);
339 static int ohci_pxa_of_init(struct platform_device *pdev)
341 struct device_node *np = pdev->dev.of_node;
342 struct pxaohci_platform_data *pdata;
349 /* Right now device-tree probed devices don't get dma_mask set.
350 * Since shared usb code relies on it, set it here for now.
351 * Once we have dma capability bindings this can go away.
353 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
357 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
361 if (of_property_read_bool(np, "marvell,enable-port1"))
362 pdata->flags |= ENABLE_PORT1;
363 if (of_property_read_bool(np, "marvell,enable-port2"))
364 pdata->flags |= ENABLE_PORT2;
365 if (of_property_read_bool(np, "marvell,enable-port3"))
366 pdata->flags |= ENABLE_PORT3;
367 if (of_property_read_bool(np, "marvell,port-sense-low"))
368 pdata->flags |= POWER_SENSE_LOW;
369 if (of_property_read_bool(np, "marvell,power-control-low"))
370 pdata->flags |= POWER_CONTROL_LOW;
371 if (of_property_read_bool(np, "marvell,no-oc-protection"))
372 pdata->flags |= NO_OC_PROTECTION;
373 if (of_property_read_bool(np, "marvell,oc-mode-perport"))
374 pdata->flags |= OC_MODE_PERPORT;
375 if (!of_property_read_u32(np, "marvell,power-on-delay", &tmp))
376 pdata->power_on_delay = tmp;
377 if (!of_property_read_u32(np, "marvell,port-mode", &tmp))
378 pdata->port_mode = tmp;
379 if (!of_property_read_u32(np, "marvell,power-budget", &tmp))
380 pdata->power_budget = tmp;
382 pdev->dev.platform_data = pdata;
387 static int ohci_pxa_of_init(struct platform_device *pdev)
393 /*-------------------------------------------------------------------------*/
395 /* configure so an HC device and id are always provided */
396 /* always called with process context; sleeping is OK */
400 * ohci_hcd_pxa27x_probe - initialize pxa27x-based HCDs
401 * @pdev: USB Host controller to probe
403 * Context: task context, might sleep
405 * Allocates basic resources for this USB host controller, and
406 * then invokes the start() method for the HCD associated with it
407 * through the hotplug entry's driver_data.
409 static int ohci_hcd_pxa27x_probe(struct platform_device *pdev)
413 struct pxaohci_platform_data *inf;
414 struct pxa27x_ohci *pxa_ohci;
415 struct ohci_hcd *ohci;
420 retval = ohci_pxa_of_init(pdev);
424 inf = dev_get_platdata(&pdev->dev);
429 irq = platform_get_irq(pdev, 0);
431 pr_err("no resource of IORESOURCE_IRQ");
435 usb_clk = devm_clk_get(&pdev->dev, NULL);
437 return PTR_ERR(usb_clk);
439 hcd = usb_create_hcd(&ohci_pxa27x_hc_driver, &pdev->dev, "pxa27x");
443 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
444 hcd->regs = devm_ioremap_resource(&pdev->dev, r);
445 if (IS_ERR(hcd->regs)) {
446 retval = PTR_ERR(hcd->regs);
449 hcd->rsrc_start = r->start;
450 hcd->rsrc_len = resource_size(r);
452 /* initialize "struct pxa27x_ohci" */
453 pxa_ohci = to_pxa27x_ohci(hcd);
454 pxa_ohci->clk = usb_clk;
455 pxa_ohci->mmio_base = (void __iomem *)hcd->regs;
457 for (i = 0; i < 3; ++i) {
460 if (!(inf->flags & (ENABLE_PORT1 << i)))
463 sprintf(name, "vbus%u", i + 1);
464 pxa_ohci->vbus[i] = devm_regulator_get(&pdev->dev, name);
467 retval = pxa27x_start_hc(pxa_ohci, &pdev->dev);
469 pr_debug("pxa27x_start_hc failed");
473 /* Select Power Management Mode */
474 pxa27x_ohci_select_pmm(pxa_ohci, inf->port_mode);
476 if (inf->power_budget)
477 hcd->power_budget = inf->power_budget;
479 /* The value of NDP in roothub_a is incorrect on this hardware */
480 ohci = hcd_to_ohci(hcd);
483 retval = usb_add_hcd(hcd, irq, 0);
485 device_wakeup_enable(hcd->self.controller);
489 pxa27x_stop_hc(pxa_ohci, &pdev->dev);
496 /* may be called without controller electrically present */
497 /* may be called with controller, bus, and devices active */
500 * ohci_hcd_pxa27x_remove - shutdown processing for pxa27x-based HCDs
501 * @pdev: USB Host Controller being removed
503 * Context: task context, might sleep
505 * Reverses the effect of ohci_hcd_pxa27x_probe(), first invoking
506 * the HCD's stop() method. It is always called from a thread
507 * context, normally "rmmod", "apmd", or something similar.
509 static int ohci_hcd_pxa27x_remove(struct platform_device *pdev)
511 struct usb_hcd *hcd = platform_get_drvdata(pdev);
512 struct pxa27x_ohci *pxa_ohci = to_pxa27x_ohci(hcd);
516 pxa27x_stop_hc(pxa_ohci, &pdev->dev);
518 for (i = 0; i < 3; ++i)
519 pxa27x_ohci_set_vbus_power(pxa_ohci, i, false);
525 /*-------------------------------------------------------------------------*/
528 static int ohci_hcd_pxa27x_drv_suspend(struct device *dev)
530 struct usb_hcd *hcd = dev_get_drvdata(dev);
531 struct pxa27x_ohci *pxa_ohci = to_pxa27x_ohci(hcd);
532 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
533 bool do_wakeup = device_may_wakeup(dev);
537 if (time_before(jiffies, ohci->next_statechange))
539 ohci->next_statechange = jiffies;
541 ret = ohci_suspend(hcd, do_wakeup);
545 pxa27x_stop_hc(pxa_ohci, dev);
549 static int ohci_hcd_pxa27x_drv_resume(struct device *dev)
551 struct usb_hcd *hcd = dev_get_drvdata(dev);
552 struct pxa27x_ohci *pxa_ohci = to_pxa27x_ohci(hcd);
553 struct pxaohci_platform_data *inf = dev_get_platdata(dev);
554 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
557 if (time_before(jiffies, ohci->next_statechange))
559 ohci->next_statechange = jiffies;
561 status = pxa27x_start_hc(pxa_ohci, dev);
565 /* Select Power Management Mode */
566 pxa27x_ohci_select_pmm(pxa_ohci, inf->port_mode);
568 ohci_resume(hcd, false);
572 static const struct dev_pm_ops ohci_hcd_pxa27x_pm_ops = {
573 .suspend = ohci_hcd_pxa27x_drv_suspend,
574 .resume = ohci_hcd_pxa27x_drv_resume,
578 static struct platform_driver ohci_hcd_pxa27x_driver = {
579 .probe = ohci_hcd_pxa27x_probe,
580 .remove = ohci_hcd_pxa27x_remove,
581 .shutdown = usb_hcd_platform_shutdown,
583 .name = "pxa27x-ohci",
584 .of_match_table = of_match_ptr(pxa_ohci_dt_ids),
586 .pm = &ohci_hcd_pxa27x_pm_ops,
591 static const struct ohci_driver_overrides pxa27x_overrides __initconst = {
592 .extra_priv_size = sizeof(struct pxa27x_ohci),
595 static int __init ohci_pxa27x_init(void)
600 ohci_init_driver(&ohci_pxa27x_hc_driver, &pxa27x_overrides);
601 ohci_pxa27x_hc_driver.hub_control = pxa27x_ohci_hub_control;
603 return platform_driver_register(&ohci_hcd_pxa27x_driver);
605 module_init(ohci_pxa27x_init);
607 static void __exit ohci_pxa27x_cleanup(void)
609 platform_driver_unregister(&ohci_hcd_pxa27x_driver);
611 module_exit(ohci_pxa27x_cleanup);
613 MODULE_DESCRIPTION(DRIVER_DESC);
614 MODULE_LICENSE("GPL");
615 MODULE_ALIAS("platform:pxa27x-ohci");