1 // SPDX-License-Identifier: GPL-2.0
3 * dwc3-omap.c - OMAP Specific Glue layer
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/irq.h>
15 #include <linux/interrupt.h>
16 #include <linux/platform_device.h>
17 #include <linux/platform_data/dwc3-omap.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/ioport.h>
23 #include <linux/of_platform.h>
24 #include <linux/extcon.h>
25 #include <linux/regulator/consumer.h>
27 #include <linux/usb/otg.h>
30 * All these registers belong to OMAP's Wrapper around the
31 * DesignWare USB3 Core.
34 #define USBOTGSS_REVISION 0x0000
35 #define USBOTGSS_SYSCONFIG 0x0010
36 #define USBOTGSS_IRQ_EOI 0x0020
37 #define USBOTGSS_EOI_OFFSET 0x0008
38 #define USBOTGSS_IRQSTATUS_RAW_0 0x0024
39 #define USBOTGSS_IRQSTATUS_0 0x0028
40 #define USBOTGSS_IRQENABLE_SET_0 0x002c
41 #define USBOTGSS_IRQENABLE_CLR_0 0x0030
42 #define USBOTGSS_IRQ0_OFFSET 0x0004
43 #define USBOTGSS_IRQSTATUS_RAW_1 0x0030
44 #define USBOTGSS_IRQSTATUS_1 0x0034
45 #define USBOTGSS_IRQENABLE_SET_1 0x0038
46 #define USBOTGSS_IRQENABLE_CLR_1 0x003c
47 #define USBOTGSS_IRQSTATUS_RAW_2 0x0040
48 #define USBOTGSS_IRQSTATUS_2 0x0044
49 #define USBOTGSS_IRQENABLE_SET_2 0x0048
50 #define USBOTGSS_IRQENABLE_CLR_2 0x004c
51 #define USBOTGSS_IRQSTATUS_RAW_3 0x0050
52 #define USBOTGSS_IRQSTATUS_3 0x0054
53 #define USBOTGSS_IRQENABLE_SET_3 0x0058
54 #define USBOTGSS_IRQENABLE_CLR_3 0x005c
55 #define USBOTGSS_IRQSTATUS_EOI_MISC 0x0030
56 #define USBOTGSS_IRQSTATUS_RAW_MISC 0x0034
57 #define USBOTGSS_IRQSTATUS_MISC 0x0038
58 #define USBOTGSS_IRQENABLE_SET_MISC 0x003c
59 #define USBOTGSS_IRQENABLE_CLR_MISC 0x0040
60 #define USBOTGSS_IRQMISC_OFFSET 0x03fc
61 #define USBOTGSS_UTMI_OTG_STATUS 0x0080
62 #define USBOTGSS_UTMI_OTG_CTRL 0x0084
63 #define USBOTGSS_UTMI_OTG_OFFSET 0x0480
64 #define USBOTGSS_TXFIFO_DEPTH 0x0508
65 #define USBOTGSS_RXFIFO_DEPTH 0x050c
66 #define USBOTGSS_MMRAM_OFFSET 0x0100
67 #define USBOTGSS_FLADJ 0x0104
68 #define USBOTGSS_DEBUG_CFG 0x0108
69 #define USBOTGSS_DEBUG_DATA 0x010c
70 #define USBOTGSS_DEV_EBC_EN 0x0110
71 #define USBOTGSS_DEBUG_OFFSET 0x0600
73 /* SYSCONFIG REGISTER */
74 #define USBOTGSS_SYSCONFIG_DMADISABLE BIT(16)
76 /* IRQ_EOI REGISTER */
77 #define USBOTGSS_IRQ_EOI_LINE_NUMBER BIT(0)
80 #define USBOTGSS_IRQO_COREIRQ_ST BIT(0)
83 #define USBOTGSS_IRQMISC_DMADISABLECLR BIT(17)
84 #define USBOTGSS_IRQMISC_OEVT BIT(16)
85 #define USBOTGSS_IRQMISC_DRVVBUS_RISE BIT(13)
86 #define USBOTGSS_IRQMISC_CHRGVBUS_RISE BIT(12)
87 #define USBOTGSS_IRQMISC_DISCHRGVBUS_RISE BIT(11)
88 #define USBOTGSS_IRQMISC_IDPULLUP_RISE BIT(8)
89 #define USBOTGSS_IRQMISC_DRVVBUS_FALL BIT(5)
90 #define USBOTGSS_IRQMISC_CHRGVBUS_FALL BIT(4)
91 #define USBOTGSS_IRQMISC_DISCHRGVBUS_FALL BIT(3)
92 #define USBOTGSS_IRQMISC_IDPULLUP_FALL BIT(0)
94 /* UTMI_OTG_STATUS REGISTER */
95 #define USBOTGSS_UTMI_OTG_STATUS_DRVVBUS BIT(5)
96 #define USBOTGSS_UTMI_OTG_STATUS_CHRGVBUS BIT(4)
97 #define USBOTGSS_UTMI_OTG_STATUS_DISCHRGVBUS BIT(3)
98 #define USBOTGSS_UTMI_OTG_STATUS_IDPULLUP BIT(0)
100 /* UTMI_OTG_CTRL REGISTER */
101 #define USBOTGSS_UTMI_OTG_CTRL_SW_MODE BIT(31)
102 #define USBOTGSS_UTMI_OTG_CTRL_POWERPRESENT BIT(9)
103 #define USBOTGSS_UTMI_OTG_CTRL_TXBITSTUFFENABLE BIT(8)
104 #define USBOTGSS_UTMI_OTG_CTRL_IDDIG BIT(4)
105 #define USBOTGSS_UTMI_OTG_CTRL_SESSEND BIT(3)
106 #define USBOTGSS_UTMI_OTG_CTRL_SESSVALID BIT(2)
107 #define USBOTGSS_UTMI_OTG_CTRL_VBUSVALID BIT(1)
122 struct extcon_dev
*edev
;
123 struct notifier_block vbus_nb
;
124 struct notifier_block id_nb
;
126 struct regulator
*vbus_reg
;
129 enum omap_dwc3_vbus_id_status
{
133 OMAP_DWC3_VBUS_VALID
,
136 static inline u32
dwc3_omap_readl(void __iomem
*base
, u32 offset
)
138 return readl(base
+ offset
);
141 static inline void dwc3_omap_writel(void __iomem
*base
, u32 offset
, u32 value
)
143 writel(value
, base
+ offset
);
146 static u32
dwc3_omap_read_utmi_ctrl(struct dwc3_omap
*omap
)
148 return dwc3_omap_readl(omap
->base
, USBOTGSS_UTMI_OTG_CTRL
+
149 omap
->utmi_otg_offset
);
152 static void dwc3_omap_write_utmi_ctrl(struct dwc3_omap
*omap
, u32 value
)
154 dwc3_omap_writel(omap
->base
, USBOTGSS_UTMI_OTG_CTRL
+
155 omap
->utmi_otg_offset
, value
);
159 static u32
dwc3_omap_read_irq0_status(struct dwc3_omap
*omap
)
161 return dwc3_omap_readl(omap
->base
, USBOTGSS_IRQSTATUS_RAW_0
-
165 static void dwc3_omap_write_irq0_status(struct dwc3_omap
*omap
, u32 value
)
167 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQSTATUS_0
-
168 omap
->irq0_offset
, value
);
172 static u32
dwc3_omap_read_irqmisc_status(struct dwc3_omap
*omap
)
174 return dwc3_omap_readl(omap
->base
, USBOTGSS_IRQSTATUS_RAW_MISC
+
175 omap
->irqmisc_offset
);
178 static void dwc3_omap_write_irqmisc_status(struct dwc3_omap
*omap
, u32 value
)
180 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQSTATUS_MISC
+
181 omap
->irqmisc_offset
, value
);
185 static void dwc3_omap_write_irqmisc_set(struct dwc3_omap
*omap
, u32 value
)
187 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQENABLE_SET_MISC
+
188 omap
->irqmisc_offset
, value
);
192 static void dwc3_omap_write_irq0_set(struct dwc3_omap
*omap
, u32 value
)
194 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQENABLE_SET_0
-
195 omap
->irq0_offset
, value
);
198 static void dwc3_omap_write_irqmisc_clr(struct dwc3_omap
*omap
, u32 value
)
200 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQENABLE_CLR_MISC
+
201 omap
->irqmisc_offset
, value
);
204 static void dwc3_omap_write_irq0_clr(struct dwc3_omap
*omap
, u32 value
)
206 dwc3_omap_writel(omap
->base
, USBOTGSS_IRQENABLE_CLR_0
-
207 omap
->irq0_offset
, value
);
210 static void dwc3_omap_set_mailbox(struct dwc3_omap
*omap
,
211 enum omap_dwc3_vbus_id_status status
)
217 case OMAP_DWC3_ID_GROUND
:
218 if (omap
->vbus_reg
) {
219 ret
= regulator_enable(omap
->vbus_reg
);
221 dev_err(omap
->dev
, "regulator enable failed\n");
226 val
= dwc3_omap_read_utmi_ctrl(omap
);
227 val
&= ~USBOTGSS_UTMI_OTG_CTRL_IDDIG
;
228 dwc3_omap_write_utmi_ctrl(omap
, val
);
231 case OMAP_DWC3_VBUS_VALID
:
232 val
= dwc3_omap_read_utmi_ctrl(omap
);
233 val
&= ~USBOTGSS_UTMI_OTG_CTRL_SESSEND
;
234 val
|= USBOTGSS_UTMI_OTG_CTRL_VBUSVALID
235 | USBOTGSS_UTMI_OTG_CTRL_SESSVALID
;
236 dwc3_omap_write_utmi_ctrl(omap
, val
);
239 case OMAP_DWC3_ID_FLOAT
:
241 regulator_disable(omap
->vbus_reg
);
242 val
= dwc3_omap_read_utmi_ctrl(omap
);
243 val
|= USBOTGSS_UTMI_OTG_CTRL_IDDIG
;
244 dwc3_omap_write_utmi_ctrl(omap
, val
);
247 case OMAP_DWC3_VBUS_OFF
:
248 val
= dwc3_omap_read_utmi_ctrl(omap
);
249 val
&= ~(USBOTGSS_UTMI_OTG_CTRL_SESSVALID
250 | USBOTGSS_UTMI_OTG_CTRL_VBUSVALID
);
251 val
|= USBOTGSS_UTMI_OTG_CTRL_SESSEND
;
252 dwc3_omap_write_utmi_ctrl(omap
, val
);
256 dev_WARN(omap
->dev
, "invalid state\n");
260 static void dwc3_omap_enable_irqs(struct dwc3_omap
*omap
);
261 static void dwc3_omap_disable_irqs(struct dwc3_omap
*omap
);
263 static irqreturn_t
dwc3_omap_interrupt(int irq
, void *_omap
)
265 struct dwc3_omap
*omap
= _omap
;
267 if (dwc3_omap_read_irqmisc_status(omap
) ||
268 dwc3_omap_read_irq0_status(omap
)) {
270 dwc3_omap_disable_irqs(omap
);
271 return IRQ_WAKE_THREAD
;
277 static irqreturn_t
dwc3_omap_interrupt_thread(int irq
, void *_omap
)
279 struct dwc3_omap
*omap
= _omap
;
282 /* clear irq status flags */
283 reg
= dwc3_omap_read_irqmisc_status(omap
);
284 dwc3_omap_write_irqmisc_status(omap
, reg
);
286 reg
= dwc3_omap_read_irq0_status(omap
);
287 dwc3_omap_write_irq0_status(omap
, reg
);
290 dwc3_omap_enable_irqs(omap
);
295 static void dwc3_omap_enable_irqs(struct dwc3_omap
*omap
)
299 /* enable all IRQs */
300 reg
= USBOTGSS_IRQO_COREIRQ_ST
;
301 dwc3_omap_write_irq0_set(omap
, reg
);
303 reg
= (USBOTGSS_IRQMISC_OEVT
|
304 USBOTGSS_IRQMISC_DRVVBUS_RISE
|
305 USBOTGSS_IRQMISC_CHRGVBUS_RISE
|
306 USBOTGSS_IRQMISC_DISCHRGVBUS_RISE
|
307 USBOTGSS_IRQMISC_IDPULLUP_RISE
|
308 USBOTGSS_IRQMISC_DRVVBUS_FALL
|
309 USBOTGSS_IRQMISC_CHRGVBUS_FALL
|
310 USBOTGSS_IRQMISC_DISCHRGVBUS_FALL
|
311 USBOTGSS_IRQMISC_IDPULLUP_FALL
);
313 dwc3_omap_write_irqmisc_set(omap
, reg
);
316 static void dwc3_omap_disable_irqs(struct dwc3_omap
*omap
)
320 /* disable all IRQs */
321 reg
= USBOTGSS_IRQO_COREIRQ_ST
;
322 dwc3_omap_write_irq0_clr(omap
, reg
);
324 reg
= (USBOTGSS_IRQMISC_OEVT
|
325 USBOTGSS_IRQMISC_DRVVBUS_RISE
|
326 USBOTGSS_IRQMISC_CHRGVBUS_RISE
|
327 USBOTGSS_IRQMISC_DISCHRGVBUS_RISE
|
328 USBOTGSS_IRQMISC_IDPULLUP_RISE
|
329 USBOTGSS_IRQMISC_DRVVBUS_FALL
|
330 USBOTGSS_IRQMISC_CHRGVBUS_FALL
|
331 USBOTGSS_IRQMISC_DISCHRGVBUS_FALL
|
332 USBOTGSS_IRQMISC_IDPULLUP_FALL
);
334 dwc3_omap_write_irqmisc_clr(omap
, reg
);
337 static int dwc3_omap_id_notifier(struct notifier_block
*nb
,
338 unsigned long event
, void *ptr
)
340 struct dwc3_omap
*omap
= container_of(nb
, struct dwc3_omap
, id_nb
);
343 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_ID_GROUND
);
345 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_ID_FLOAT
);
350 static int dwc3_omap_vbus_notifier(struct notifier_block
*nb
,
351 unsigned long event
, void *ptr
)
353 struct dwc3_omap
*omap
= container_of(nb
, struct dwc3_omap
, vbus_nb
);
356 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_VBUS_VALID
);
358 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_VBUS_OFF
);
363 static void dwc3_omap_map_offset(struct dwc3_omap
*omap
)
365 struct device_node
*node
= omap
->dev
->of_node
;
368 * Differentiate between OMAP5 and AM437x.
370 * For OMAP5(ES2.0) and AM437x wrapper revision is same, even
371 * though there are changes in wrapper register offsets.
373 * Using dt compatible to differentiate AM437x.
375 if (of_device_is_compatible(node
, "ti,am437x-dwc3")) {
376 omap
->irq_eoi_offset
= USBOTGSS_EOI_OFFSET
;
377 omap
->irq0_offset
= USBOTGSS_IRQ0_OFFSET
;
378 omap
->irqmisc_offset
= USBOTGSS_IRQMISC_OFFSET
;
379 omap
->utmi_otg_offset
= USBOTGSS_UTMI_OTG_OFFSET
;
380 omap
->debug_offset
= USBOTGSS_DEBUG_OFFSET
;
384 static void dwc3_omap_set_utmi_mode(struct dwc3_omap
*omap
)
387 struct device_node
*node
= omap
->dev
->of_node
;
390 reg
= dwc3_omap_read_utmi_ctrl(omap
);
392 of_property_read_u32(node
, "utmi-mode", &utmi_mode
);
395 case DWC3_OMAP_UTMI_MODE_SW
:
396 reg
|= USBOTGSS_UTMI_OTG_CTRL_SW_MODE
;
398 case DWC3_OMAP_UTMI_MODE_HW
:
399 reg
&= ~USBOTGSS_UTMI_OTG_CTRL_SW_MODE
;
402 dev_WARN(omap
->dev
, "UNKNOWN utmi mode %d\n", utmi_mode
);
405 dwc3_omap_write_utmi_ctrl(omap
, reg
);
408 static int dwc3_omap_extcon_register(struct dwc3_omap
*omap
)
411 struct device_node
*node
= omap
->dev
->of_node
;
412 struct extcon_dev
*edev
;
414 if (of_property_read_bool(node
, "extcon")) {
415 edev
= extcon_get_edev_by_phandle(omap
->dev
, 0);
417 dev_vdbg(omap
->dev
, "couldn't get extcon device\n");
418 return -EPROBE_DEFER
;
421 omap
->vbus_nb
.notifier_call
= dwc3_omap_vbus_notifier
;
422 ret
= devm_extcon_register_notifier(omap
->dev
, edev
,
423 EXTCON_USB
, &omap
->vbus_nb
);
425 dev_vdbg(omap
->dev
, "failed to register notifier for USB\n");
427 omap
->id_nb
.notifier_call
= dwc3_omap_id_notifier
;
428 ret
= devm_extcon_register_notifier(omap
->dev
, edev
,
429 EXTCON_USB_HOST
, &omap
->id_nb
);
431 dev_vdbg(omap
->dev
, "failed to register notifier for USB-HOST\n");
433 if (extcon_get_state(edev
, EXTCON_USB
) == true)
434 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_VBUS_VALID
);
435 if (extcon_get_state(edev
, EXTCON_USB_HOST
) == true)
436 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_ID_GROUND
);
444 static int dwc3_omap_probe(struct platform_device
*pdev
)
446 struct device_node
*node
= pdev
->dev
.of_node
;
448 struct dwc3_omap
*omap
;
449 struct resource
*res
;
450 struct device
*dev
= &pdev
->dev
;
451 struct regulator
*vbus_reg
= NULL
;
461 dev_err(dev
, "device node not found\n");
465 omap
= devm_kzalloc(dev
, sizeof(*omap
), GFP_KERNEL
);
469 platform_set_drvdata(pdev
, omap
);
471 irq
= platform_get_irq(pdev
, 0);
473 dev_err(dev
, "missing IRQ resource: %d\n", irq
);
477 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
478 base
= devm_ioremap_resource(dev
, res
);
480 return PTR_ERR(base
);
482 if (of_property_read_bool(node
, "vbus-supply")) {
483 vbus_reg
= devm_regulator_get(dev
, "vbus");
484 if (IS_ERR(vbus_reg
)) {
485 dev_err(dev
, "vbus init failed\n");
486 return PTR_ERR(vbus_reg
);
493 omap
->vbus_reg
= vbus_reg
;
495 pm_runtime_enable(dev
);
496 ret
= pm_runtime_get_sync(dev
);
498 dev_err(dev
, "get_sync failed with err %d\n", ret
);
502 dwc3_omap_map_offset(omap
);
503 dwc3_omap_set_utmi_mode(omap
);
505 /* check the DMA Status */
506 reg
= dwc3_omap_readl(omap
->base
, USBOTGSS_SYSCONFIG
);
508 ret
= dwc3_omap_extcon_register(omap
);
512 ret
= of_platform_populate(node
, NULL
, NULL
, dev
);
514 dev_err(&pdev
->dev
, "failed to create dwc3 core\n");
518 ret
= devm_request_threaded_irq(dev
, omap
->irq
, dwc3_omap_interrupt
,
519 dwc3_omap_interrupt_thread
, IRQF_SHARED
,
522 dev_err(dev
, "failed to request IRQ #%d --> %d\n",
526 dwc3_omap_enable_irqs(omap
);
530 pm_runtime_put_sync(dev
);
531 pm_runtime_disable(dev
);
536 static int dwc3_omap_remove(struct platform_device
*pdev
)
538 struct dwc3_omap
*omap
= platform_get_drvdata(pdev
);
540 dwc3_omap_disable_irqs(omap
);
541 disable_irq(omap
->irq
);
542 of_platform_depopulate(omap
->dev
);
543 pm_runtime_put_sync(&pdev
->dev
);
544 pm_runtime_disable(&pdev
->dev
);
549 static const struct of_device_id of_dwc3_match
[] = {
551 .compatible
= "ti,dwc3"
554 .compatible
= "ti,am437x-dwc3"
558 MODULE_DEVICE_TABLE(of
, of_dwc3_match
);
560 #ifdef CONFIG_PM_SLEEP
561 static int dwc3_omap_suspend(struct device
*dev
)
563 struct dwc3_omap
*omap
= dev_get_drvdata(dev
);
565 omap
->utmi_otg_ctrl
= dwc3_omap_read_utmi_ctrl(omap
);
566 dwc3_omap_disable_irqs(omap
);
571 static int dwc3_omap_resume(struct device
*dev
)
573 struct dwc3_omap
*omap
= dev_get_drvdata(dev
);
575 dwc3_omap_write_utmi_ctrl(omap
, omap
->utmi_otg_ctrl
);
576 dwc3_omap_enable_irqs(omap
);
578 pm_runtime_disable(dev
);
579 pm_runtime_set_active(dev
);
580 pm_runtime_enable(dev
);
585 static void dwc3_omap_complete(struct device
*dev
)
587 struct dwc3_omap
*omap
= dev_get_drvdata(dev
);
589 if (extcon_get_state(omap
->edev
, EXTCON_USB
))
590 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_VBUS_VALID
);
592 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_VBUS_OFF
);
594 if (extcon_get_state(omap
->edev
, EXTCON_USB_HOST
))
595 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_ID_GROUND
);
597 dwc3_omap_set_mailbox(omap
, OMAP_DWC3_ID_FLOAT
);
600 static const struct dev_pm_ops dwc3_omap_dev_pm_ops
= {
602 SET_SYSTEM_SLEEP_PM_OPS(dwc3_omap_suspend
, dwc3_omap_resume
)
603 .complete
= dwc3_omap_complete
,
606 #define DEV_PM_OPS (&dwc3_omap_dev_pm_ops)
608 #define DEV_PM_OPS NULL
609 #endif /* CONFIG_PM_SLEEP */
611 static struct platform_driver dwc3_omap_driver
= {
612 .probe
= dwc3_omap_probe
,
613 .remove
= dwc3_omap_remove
,
616 .of_match_table
= of_dwc3_match
,
621 module_platform_driver(dwc3_omap_driver
);
623 MODULE_ALIAS("platform:omap-dwc3");
624 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
625 MODULE_LICENSE("GPL v2");
626 MODULE_DESCRIPTION("DesignWare USB3 OMAP Glue Layer");