WIP FPC-III support
[linux/fpc-iii.git] / drivers / usb / dwc3 / dwc3-omap.c
blob3db17806e92e7df6c132bb0c71027eb8346748dd
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * dwc3-omap.c - OMAP Specific Glue layer
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 */
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/pm_runtime.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/ioport.h>
20 #include <linux/io.h>
21 #include <linux/of.h>
22 #include <linux/of_platform.h>
23 #include <linux/extcon.h>
24 #include <linux/regulator/consumer.h>
26 #include <linux/usb/otg.h>
29 * All these registers belong to OMAP's Wrapper around the
30 * DesignWare USB3 Core.
33 #define USBOTGSS_REVISION 0x0000
34 #define USBOTGSS_SYSCONFIG 0x0010
35 #define USBOTGSS_IRQ_EOI 0x0020
36 #define USBOTGSS_EOI_OFFSET 0x0008
37 #define USBOTGSS_IRQSTATUS_RAW_0 0x0024
38 #define USBOTGSS_IRQSTATUS_0 0x0028
39 #define USBOTGSS_IRQENABLE_SET_0 0x002c
40 #define USBOTGSS_IRQENABLE_CLR_0 0x0030
41 #define USBOTGSS_IRQ0_OFFSET 0x0004
42 #define USBOTGSS_IRQSTATUS_RAW_1 0x0030
43 #define USBOTGSS_IRQSTATUS_1 0x0034
44 #define USBOTGSS_IRQENABLE_SET_1 0x0038
45 #define USBOTGSS_IRQENABLE_CLR_1 0x003c
46 #define USBOTGSS_IRQSTATUS_RAW_2 0x0040
47 #define USBOTGSS_IRQSTATUS_2 0x0044
48 #define USBOTGSS_IRQENABLE_SET_2 0x0048
49 #define USBOTGSS_IRQENABLE_CLR_2 0x004c
50 #define USBOTGSS_IRQSTATUS_RAW_3 0x0050
51 #define USBOTGSS_IRQSTATUS_3 0x0054
52 #define USBOTGSS_IRQENABLE_SET_3 0x0058
53 #define USBOTGSS_IRQENABLE_CLR_3 0x005c
54 #define USBOTGSS_IRQSTATUS_EOI_MISC 0x0030
55 #define USBOTGSS_IRQSTATUS_RAW_MISC 0x0034
56 #define USBOTGSS_IRQSTATUS_MISC 0x0038
57 #define USBOTGSS_IRQENABLE_SET_MISC 0x003c
58 #define USBOTGSS_IRQENABLE_CLR_MISC 0x0040
59 #define USBOTGSS_IRQMISC_OFFSET 0x03fc
60 #define USBOTGSS_UTMI_OTG_STATUS 0x0080
61 #define USBOTGSS_UTMI_OTG_CTRL 0x0084
62 #define USBOTGSS_UTMI_OTG_OFFSET 0x0480
63 #define USBOTGSS_TXFIFO_DEPTH 0x0508
64 #define USBOTGSS_RXFIFO_DEPTH 0x050c
65 #define USBOTGSS_MMRAM_OFFSET 0x0100
66 #define USBOTGSS_FLADJ 0x0104
67 #define USBOTGSS_DEBUG_CFG 0x0108
68 #define USBOTGSS_DEBUG_DATA 0x010c
69 #define USBOTGSS_DEV_EBC_EN 0x0110
70 #define USBOTGSS_DEBUG_OFFSET 0x0600
72 /* SYSCONFIG REGISTER */
73 #define USBOTGSS_SYSCONFIG_DMADISABLE BIT(16)
75 /* IRQ_EOI REGISTER */
76 #define USBOTGSS_IRQ_EOI_LINE_NUMBER BIT(0)
78 /* IRQS0 BITS */
79 #define USBOTGSS_IRQO_COREIRQ_ST BIT(0)
81 /* IRQMISC BITS */
82 #define USBOTGSS_IRQMISC_DMADISABLECLR BIT(17)
83 #define USBOTGSS_IRQMISC_OEVT BIT(16)
84 #define USBOTGSS_IRQMISC_DRVVBUS_RISE BIT(13)
85 #define USBOTGSS_IRQMISC_CHRGVBUS_RISE BIT(12)
86 #define USBOTGSS_IRQMISC_DISCHRGVBUS_RISE BIT(11)
87 #define USBOTGSS_IRQMISC_IDPULLUP_RISE BIT(8)
88 #define USBOTGSS_IRQMISC_DRVVBUS_FALL BIT(5)
89 #define USBOTGSS_IRQMISC_CHRGVBUS_FALL BIT(4)
90 #define USBOTGSS_IRQMISC_DISCHRGVBUS_FALL BIT(3)
91 #define USBOTGSS_IRQMISC_IDPULLUP_FALL BIT(0)
93 /* UTMI_OTG_STATUS REGISTER */
94 #define USBOTGSS_UTMI_OTG_STATUS_DRVVBUS BIT(5)
95 #define USBOTGSS_UTMI_OTG_STATUS_CHRGVBUS BIT(4)
96 #define USBOTGSS_UTMI_OTG_STATUS_DISCHRGVBUS BIT(3)
97 #define USBOTGSS_UTMI_OTG_STATUS_IDPULLUP BIT(0)
99 /* UTMI_OTG_CTRL REGISTER */
100 #define USBOTGSS_UTMI_OTG_CTRL_SW_MODE BIT(31)
101 #define USBOTGSS_UTMI_OTG_CTRL_POWERPRESENT BIT(9)
102 #define USBOTGSS_UTMI_OTG_CTRL_TXBITSTUFFENABLE BIT(8)
103 #define USBOTGSS_UTMI_OTG_CTRL_IDDIG BIT(4)
104 #define USBOTGSS_UTMI_OTG_CTRL_SESSEND BIT(3)
105 #define USBOTGSS_UTMI_OTG_CTRL_SESSVALID BIT(2)
106 #define USBOTGSS_UTMI_OTG_CTRL_VBUSVALID BIT(1)
108 enum dwc3_omap_utmi_mode {
109 DWC3_OMAP_UTMI_MODE_UNKNOWN = 0,
110 DWC3_OMAP_UTMI_MODE_HW,
111 DWC3_OMAP_UTMI_MODE_SW,
114 struct dwc3_omap {
115 struct device *dev;
117 int irq;
118 void __iomem *base;
120 u32 utmi_otg_ctrl;
121 u32 utmi_otg_offset;
122 u32 irqmisc_offset;
123 u32 irq_eoi_offset;
124 u32 debug_offset;
125 u32 irq0_offset;
127 struct extcon_dev *edev;
128 struct notifier_block vbus_nb;
129 struct notifier_block id_nb;
131 struct regulator *vbus_reg;
134 enum omap_dwc3_vbus_id_status {
135 OMAP_DWC3_ID_FLOAT,
136 OMAP_DWC3_ID_GROUND,
137 OMAP_DWC3_VBUS_OFF,
138 OMAP_DWC3_VBUS_VALID,
141 static inline u32 dwc3_omap_readl(void __iomem *base, u32 offset)
143 return readl(base + offset);
146 static inline void dwc3_omap_writel(void __iomem *base, u32 offset, u32 value)
148 writel(value, base + offset);
151 static u32 dwc3_omap_read_utmi_ctrl(struct dwc3_omap *omap)
153 return dwc3_omap_readl(omap->base, USBOTGSS_UTMI_OTG_CTRL +
154 omap->utmi_otg_offset);
157 static void dwc3_omap_write_utmi_ctrl(struct dwc3_omap *omap, u32 value)
159 dwc3_omap_writel(omap->base, USBOTGSS_UTMI_OTG_CTRL +
160 omap->utmi_otg_offset, value);
164 static u32 dwc3_omap_read_irq0_status(struct dwc3_omap *omap)
166 return dwc3_omap_readl(omap->base, USBOTGSS_IRQSTATUS_RAW_0 -
167 omap->irq0_offset);
170 static void dwc3_omap_write_irq0_status(struct dwc3_omap *omap, u32 value)
172 dwc3_omap_writel(omap->base, USBOTGSS_IRQSTATUS_0 -
173 omap->irq0_offset, value);
177 static u32 dwc3_omap_read_irqmisc_status(struct dwc3_omap *omap)
179 return dwc3_omap_readl(omap->base, USBOTGSS_IRQSTATUS_RAW_MISC +
180 omap->irqmisc_offset);
183 static void dwc3_omap_write_irqmisc_status(struct dwc3_omap *omap, u32 value)
185 dwc3_omap_writel(omap->base, USBOTGSS_IRQSTATUS_MISC +
186 omap->irqmisc_offset, value);
190 static void dwc3_omap_write_irqmisc_set(struct dwc3_omap *omap, u32 value)
192 dwc3_omap_writel(omap->base, USBOTGSS_IRQENABLE_SET_MISC +
193 omap->irqmisc_offset, value);
197 static void dwc3_omap_write_irq0_set(struct dwc3_omap *omap, u32 value)
199 dwc3_omap_writel(omap->base, USBOTGSS_IRQENABLE_SET_0 -
200 omap->irq0_offset, value);
203 static void dwc3_omap_write_irqmisc_clr(struct dwc3_omap *omap, u32 value)
205 dwc3_omap_writel(omap->base, USBOTGSS_IRQENABLE_CLR_MISC +
206 omap->irqmisc_offset, value);
209 static void dwc3_omap_write_irq0_clr(struct dwc3_omap *omap, u32 value)
211 dwc3_omap_writel(omap->base, USBOTGSS_IRQENABLE_CLR_0 -
212 omap->irq0_offset, value);
215 static void dwc3_omap_set_mailbox(struct dwc3_omap *omap,
216 enum omap_dwc3_vbus_id_status status)
218 int ret;
219 u32 val;
221 switch (status) {
222 case OMAP_DWC3_ID_GROUND:
223 if (omap->vbus_reg) {
224 ret = regulator_enable(omap->vbus_reg);
225 if (ret) {
226 dev_err(omap->dev, "regulator enable failed\n");
227 return;
231 val = dwc3_omap_read_utmi_ctrl(omap);
232 val &= ~USBOTGSS_UTMI_OTG_CTRL_IDDIG;
233 dwc3_omap_write_utmi_ctrl(omap, val);
234 break;
236 case OMAP_DWC3_VBUS_VALID:
237 val = dwc3_omap_read_utmi_ctrl(omap);
238 val &= ~USBOTGSS_UTMI_OTG_CTRL_SESSEND;
239 val |= USBOTGSS_UTMI_OTG_CTRL_VBUSVALID
240 | USBOTGSS_UTMI_OTG_CTRL_SESSVALID;
241 dwc3_omap_write_utmi_ctrl(omap, val);
242 break;
244 case OMAP_DWC3_ID_FLOAT:
245 if (omap->vbus_reg)
246 regulator_disable(omap->vbus_reg);
247 val = dwc3_omap_read_utmi_ctrl(omap);
248 val |= USBOTGSS_UTMI_OTG_CTRL_IDDIG;
249 dwc3_omap_write_utmi_ctrl(omap, val);
250 break;
252 case OMAP_DWC3_VBUS_OFF:
253 val = dwc3_omap_read_utmi_ctrl(omap);
254 val &= ~(USBOTGSS_UTMI_OTG_CTRL_SESSVALID
255 | USBOTGSS_UTMI_OTG_CTRL_VBUSVALID);
256 val |= USBOTGSS_UTMI_OTG_CTRL_SESSEND;
257 dwc3_omap_write_utmi_ctrl(omap, val);
258 break;
260 default:
261 dev_WARN(omap->dev, "invalid state\n");
265 static void dwc3_omap_enable_irqs(struct dwc3_omap *omap);
266 static void dwc3_omap_disable_irqs(struct dwc3_omap *omap);
268 static irqreturn_t dwc3_omap_interrupt(int irq, void *_omap)
270 struct dwc3_omap *omap = _omap;
272 if (dwc3_omap_read_irqmisc_status(omap) ||
273 dwc3_omap_read_irq0_status(omap)) {
274 /* mask irqs */
275 dwc3_omap_disable_irqs(omap);
276 return IRQ_WAKE_THREAD;
279 return IRQ_NONE;
282 static irqreturn_t dwc3_omap_interrupt_thread(int irq, void *_omap)
284 struct dwc3_omap *omap = _omap;
285 u32 reg;
287 /* clear irq status flags */
288 reg = dwc3_omap_read_irqmisc_status(omap);
289 dwc3_omap_write_irqmisc_status(omap, reg);
291 reg = dwc3_omap_read_irq0_status(omap);
292 dwc3_omap_write_irq0_status(omap, reg);
294 /* unmask irqs */
295 dwc3_omap_enable_irqs(omap);
297 return IRQ_HANDLED;
300 static void dwc3_omap_enable_irqs(struct dwc3_omap *omap)
302 u32 reg;
304 /* enable all IRQs */
305 reg = USBOTGSS_IRQO_COREIRQ_ST;
306 dwc3_omap_write_irq0_set(omap, reg);
308 reg = (USBOTGSS_IRQMISC_OEVT |
309 USBOTGSS_IRQMISC_DRVVBUS_RISE |
310 USBOTGSS_IRQMISC_CHRGVBUS_RISE |
311 USBOTGSS_IRQMISC_DISCHRGVBUS_RISE |
312 USBOTGSS_IRQMISC_IDPULLUP_RISE |
313 USBOTGSS_IRQMISC_DRVVBUS_FALL |
314 USBOTGSS_IRQMISC_CHRGVBUS_FALL |
315 USBOTGSS_IRQMISC_DISCHRGVBUS_FALL |
316 USBOTGSS_IRQMISC_IDPULLUP_FALL);
318 dwc3_omap_write_irqmisc_set(omap, reg);
321 static void dwc3_omap_disable_irqs(struct dwc3_omap *omap)
323 u32 reg;
325 /* disable all IRQs */
326 reg = USBOTGSS_IRQO_COREIRQ_ST;
327 dwc3_omap_write_irq0_clr(omap, reg);
329 reg = (USBOTGSS_IRQMISC_OEVT |
330 USBOTGSS_IRQMISC_DRVVBUS_RISE |
331 USBOTGSS_IRQMISC_CHRGVBUS_RISE |
332 USBOTGSS_IRQMISC_DISCHRGVBUS_RISE |
333 USBOTGSS_IRQMISC_IDPULLUP_RISE |
334 USBOTGSS_IRQMISC_DRVVBUS_FALL |
335 USBOTGSS_IRQMISC_CHRGVBUS_FALL |
336 USBOTGSS_IRQMISC_DISCHRGVBUS_FALL |
337 USBOTGSS_IRQMISC_IDPULLUP_FALL);
339 dwc3_omap_write_irqmisc_clr(omap, reg);
342 static int dwc3_omap_id_notifier(struct notifier_block *nb,
343 unsigned long event, void *ptr)
345 struct dwc3_omap *omap = container_of(nb, struct dwc3_omap, id_nb);
347 if (event)
348 dwc3_omap_set_mailbox(omap, OMAP_DWC3_ID_GROUND);
349 else
350 dwc3_omap_set_mailbox(omap, OMAP_DWC3_ID_FLOAT);
352 return NOTIFY_DONE;
355 static int dwc3_omap_vbus_notifier(struct notifier_block *nb,
356 unsigned long event, void *ptr)
358 struct dwc3_omap *omap = container_of(nb, struct dwc3_omap, vbus_nb);
360 if (event)
361 dwc3_omap_set_mailbox(omap, OMAP_DWC3_VBUS_VALID);
362 else
363 dwc3_omap_set_mailbox(omap, OMAP_DWC3_VBUS_OFF);
365 return NOTIFY_DONE;
368 static void dwc3_omap_map_offset(struct dwc3_omap *omap)
370 struct device_node *node = omap->dev->of_node;
373 * Differentiate between OMAP5 and AM437x.
375 * For OMAP5(ES2.0) and AM437x wrapper revision is same, even
376 * though there are changes in wrapper register offsets.
378 * Using dt compatible to differentiate AM437x.
380 if (of_device_is_compatible(node, "ti,am437x-dwc3")) {
381 omap->irq_eoi_offset = USBOTGSS_EOI_OFFSET;
382 omap->irq0_offset = USBOTGSS_IRQ0_OFFSET;
383 omap->irqmisc_offset = USBOTGSS_IRQMISC_OFFSET;
384 omap->utmi_otg_offset = USBOTGSS_UTMI_OTG_OFFSET;
385 omap->debug_offset = USBOTGSS_DEBUG_OFFSET;
389 static void dwc3_omap_set_utmi_mode(struct dwc3_omap *omap)
391 u32 reg;
392 struct device_node *node = omap->dev->of_node;
393 u32 utmi_mode = 0;
395 reg = dwc3_omap_read_utmi_ctrl(omap);
397 of_property_read_u32(node, "utmi-mode", &utmi_mode);
399 switch (utmi_mode) {
400 case DWC3_OMAP_UTMI_MODE_SW:
401 reg |= USBOTGSS_UTMI_OTG_CTRL_SW_MODE;
402 break;
403 case DWC3_OMAP_UTMI_MODE_HW:
404 reg &= ~USBOTGSS_UTMI_OTG_CTRL_SW_MODE;
405 break;
406 default:
407 dev_WARN(omap->dev, "UNKNOWN utmi mode %d\n", utmi_mode);
410 dwc3_omap_write_utmi_ctrl(omap, reg);
413 static int dwc3_omap_extcon_register(struct dwc3_omap *omap)
415 int ret;
416 struct device_node *node = omap->dev->of_node;
417 struct extcon_dev *edev;
419 if (of_property_read_bool(node, "extcon")) {
420 edev = extcon_get_edev_by_phandle(omap->dev, 0);
421 if (IS_ERR(edev)) {
422 dev_vdbg(omap->dev, "couldn't get extcon device\n");
423 return -EPROBE_DEFER;
426 omap->vbus_nb.notifier_call = dwc3_omap_vbus_notifier;
427 ret = devm_extcon_register_notifier(omap->dev, edev,
428 EXTCON_USB, &omap->vbus_nb);
429 if (ret < 0)
430 dev_vdbg(omap->dev, "failed to register notifier for USB\n");
432 omap->id_nb.notifier_call = dwc3_omap_id_notifier;
433 ret = devm_extcon_register_notifier(omap->dev, edev,
434 EXTCON_USB_HOST, &omap->id_nb);
435 if (ret < 0)
436 dev_vdbg(omap->dev, "failed to register notifier for USB-HOST\n");
438 if (extcon_get_state(edev, EXTCON_USB) == true)
439 dwc3_omap_set_mailbox(omap, OMAP_DWC3_VBUS_VALID);
440 if (extcon_get_state(edev, EXTCON_USB_HOST) == true)
441 dwc3_omap_set_mailbox(omap, OMAP_DWC3_ID_GROUND);
443 omap->edev = edev;
446 return 0;
449 static int dwc3_omap_probe(struct platform_device *pdev)
451 struct device_node *node = pdev->dev.of_node;
453 struct dwc3_omap *omap;
454 struct device *dev = &pdev->dev;
455 struct regulator *vbus_reg = NULL;
457 int ret;
458 int irq;
460 void __iomem *base;
462 if (!node) {
463 dev_err(dev, "device node not found\n");
464 return -EINVAL;
467 omap = devm_kzalloc(dev, sizeof(*omap), GFP_KERNEL);
468 if (!omap)
469 return -ENOMEM;
471 platform_set_drvdata(pdev, omap);
473 irq = platform_get_irq(pdev, 0);
474 if (irq < 0)
475 return irq;
477 base = devm_platform_ioremap_resource(pdev, 0);
478 if (IS_ERR(base))
479 return PTR_ERR(base);
481 if (of_property_read_bool(node, "vbus-supply")) {
482 vbus_reg = devm_regulator_get(dev, "vbus");
483 if (IS_ERR(vbus_reg)) {
484 dev_err(dev, "vbus init failed\n");
485 return PTR_ERR(vbus_reg);
489 omap->dev = dev;
490 omap->irq = irq;
491 omap->base = base;
492 omap->vbus_reg = vbus_reg;
494 pm_runtime_enable(dev);
495 ret = pm_runtime_get_sync(dev);
496 if (ret < 0) {
497 dev_err(dev, "get_sync failed with err %d\n", ret);
498 goto err1;
501 dwc3_omap_map_offset(omap);
502 dwc3_omap_set_utmi_mode(omap);
504 ret = dwc3_omap_extcon_register(omap);
505 if (ret < 0)
506 goto err1;
508 ret = of_platform_populate(node, NULL, NULL, dev);
509 if (ret) {
510 dev_err(&pdev->dev, "failed to create dwc3 core\n");
511 goto err1;
514 ret = devm_request_threaded_irq(dev, omap->irq, dwc3_omap_interrupt,
515 dwc3_omap_interrupt_thread, IRQF_SHARED,
516 "dwc3-omap", omap);
517 if (ret) {
518 dev_err(dev, "failed to request IRQ #%d --> %d\n",
519 omap->irq, ret);
520 goto err1;
522 dwc3_omap_enable_irqs(omap);
523 return 0;
525 err1:
526 pm_runtime_put_sync(dev);
527 pm_runtime_disable(dev);
529 return ret;
532 static int dwc3_omap_remove(struct platform_device *pdev)
534 struct dwc3_omap *omap = platform_get_drvdata(pdev);
536 dwc3_omap_disable_irqs(omap);
537 disable_irq(omap->irq);
538 of_platform_depopulate(omap->dev);
539 pm_runtime_put_sync(&pdev->dev);
540 pm_runtime_disable(&pdev->dev);
542 return 0;
545 static const struct of_device_id of_dwc3_match[] = {
547 .compatible = "ti,dwc3"
550 .compatible = "ti,am437x-dwc3"
552 { },
554 MODULE_DEVICE_TABLE(of, of_dwc3_match);
556 #ifdef CONFIG_PM_SLEEP
557 static int dwc3_omap_suspend(struct device *dev)
559 struct dwc3_omap *omap = dev_get_drvdata(dev);
561 omap->utmi_otg_ctrl = dwc3_omap_read_utmi_ctrl(omap);
562 dwc3_omap_disable_irqs(omap);
564 return 0;
567 static int dwc3_omap_resume(struct device *dev)
569 struct dwc3_omap *omap = dev_get_drvdata(dev);
571 dwc3_omap_write_utmi_ctrl(omap, omap->utmi_otg_ctrl);
572 dwc3_omap_enable_irqs(omap);
574 pm_runtime_disable(dev);
575 pm_runtime_set_active(dev);
576 pm_runtime_enable(dev);
578 return 0;
581 static void dwc3_omap_complete(struct device *dev)
583 struct dwc3_omap *omap = dev_get_drvdata(dev);
585 if (extcon_get_state(omap->edev, EXTCON_USB))
586 dwc3_omap_set_mailbox(omap, OMAP_DWC3_VBUS_VALID);
587 else
588 dwc3_omap_set_mailbox(omap, OMAP_DWC3_VBUS_OFF);
590 if (extcon_get_state(omap->edev, EXTCON_USB_HOST))
591 dwc3_omap_set_mailbox(omap, OMAP_DWC3_ID_GROUND);
592 else
593 dwc3_omap_set_mailbox(omap, OMAP_DWC3_ID_FLOAT);
596 static const struct dev_pm_ops dwc3_omap_dev_pm_ops = {
598 SET_SYSTEM_SLEEP_PM_OPS(dwc3_omap_suspend, dwc3_omap_resume)
599 .complete = dwc3_omap_complete,
602 #define DEV_PM_OPS (&dwc3_omap_dev_pm_ops)
603 #else
604 #define DEV_PM_OPS NULL
605 #endif /* CONFIG_PM_SLEEP */
607 static struct platform_driver dwc3_omap_driver = {
608 .probe = dwc3_omap_probe,
609 .remove = dwc3_omap_remove,
610 .driver = {
611 .name = "omap-dwc3",
612 .of_match_table = of_dwc3_match,
613 .pm = DEV_PM_OPS,
617 module_platform_driver(dwc3_omap_driver);
619 MODULE_ALIAS("platform:omap-dwc3");
620 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
621 MODULE_LICENSE("GPL v2");
622 MODULE_DESCRIPTION("DesignWare USB3 OMAP Glue Layer");