1 // SPDX-License-Identifier: GPL-2.0
3 * Texas Instruments DA8xx/OMAP-L1x "glue layer"
5 * Copyright (c) 2008-2009 MontaVista Software, Inc. <source@mvista.com>
7 * Based on the DaVinci "glue layer" code.
8 * Copyright (C) 2005-2006 by Texas Instruments
11 * Copyright (c) 2016 Petr Kulhavy <petr@barix.com>
13 * This file is part of the Inventra Controller Driver for Linux.
16 #include <linux/module.h>
17 #include <linux/clk.h>
18 #include <linux/err.h>
20 #include <linux/of_platform.h>
21 #include <linux/phy/phy.h>
22 #include <linux/platform_device.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/usb/usb_phy_generic.h>
26 #include "musb_core.h"
29 * DA8XX specific definitions
32 /* USB 2.0 OTG module registers */
33 #define DA8XX_USB_REVISION_REG 0x00
34 #define DA8XX_USB_CTRL_REG 0x04
35 #define DA8XX_USB_STAT_REG 0x08
36 #define DA8XX_USB_EMULATION_REG 0x0c
37 #define DA8XX_USB_SRP_FIX_TIME_REG 0x18
38 #define DA8XX_USB_INTR_SRC_REG 0x20
39 #define DA8XX_USB_INTR_SRC_SET_REG 0x24
40 #define DA8XX_USB_INTR_SRC_CLEAR_REG 0x28
41 #define DA8XX_USB_INTR_MASK_REG 0x2c
42 #define DA8XX_USB_INTR_MASK_SET_REG 0x30
43 #define DA8XX_USB_INTR_MASK_CLEAR_REG 0x34
44 #define DA8XX_USB_INTR_SRC_MASKED_REG 0x38
45 #define DA8XX_USB_END_OF_INTR_REG 0x3c
46 #define DA8XX_USB_GENERIC_RNDIS_EP_SIZE_REG(n) (0x50 + (((n) - 1) << 2))
48 /* Control register bits */
49 #define DA8XX_SOFT_RESET_MASK 1
51 #define DA8XX_USB_TX_EP_MASK 0x1f /* EP0 + 4 Tx EPs */
52 #define DA8XX_USB_RX_EP_MASK 0x1e /* 4 Rx EPs */
54 /* USB interrupt register bits */
55 #define DA8XX_INTR_USB_SHIFT 16
56 #define DA8XX_INTR_USB_MASK (0x1ff << DA8XX_INTR_USB_SHIFT) /* 8 Mentor */
57 /* interrupts and DRVVBUS interrupt */
58 #define DA8XX_INTR_DRVVBUS 0x100
59 #define DA8XX_INTR_RX_SHIFT 8
60 #define DA8XX_INTR_RX_MASK (DA8XX_USB_RX_EP_MASK << DA8XX_INTR_RX_SHIFT)
61 #define DA8XX_INTR_TX_SHIFT 0
62 #define DA8XX_INTR_TX_MASK (DA8XX_USB_TX_EP_MASK << DA8XX_INTR_TX_SHIFT)
64 #define DA8XX_MENTOR_CORE_OFFSET 0x400
68 struct platform_device
*musb
;
69 struct platform_device
*usb_phy
;
75 * Because we don't set CTRL.UINT, it's "important" to:
76 * - not read/write INTRUSB/INTRUSBE (except during
77 * initial setup, as a workaround);
78 * - use INTSET/INTCLR instead.
82 * da8xx_musb_enable - enable interrupts
84 static void da8xx_musb_enable(struct musb
*musb
)
86 void __iomem
*reg_base
= musb
->ctrl_base
;
89 /* Workaround: setup IRQs through both register sets. */
90 mask
= ((musb
->epmask
& DA8XX_USB_TX_EP_MASK
) << DA8XX_INTR_TX_SHIFT
) |
91 ((musb
->epmask
& DA8XX_USB_RX_EP_MASK
) << DA8XX_INTR_RX_SHIFT
) |
93 musb_writel(reg_base
, DA8XX_USB_INTR_MASK_SET_REG
, mask
);
95 /* Force the DRVVBUS IRQ so we can start polling for ID change. */
96 musb_writel(reg_base
, DA8XX_USB_INTR_SRC_SET_REG
,
97 DA8XX_INTR_DRVVBUS
<< DA8XX_INTR_USB_SHIFT
);
101 * da8xx_musb_disable - disable HDRC and flush interrupts
103 static void da8xx_musb_disable(struct musb
*musb
)
105 void __iomem
*reg_base
= musb
->ctrl_base
;
107 musb_writel(reg_base
, DA8XX_USB_INTR_MASK_CLEAR_REG
,
108 DA8XX_INTR_USB_MASK
|
109 DA8XX_INTR_TX_MASK
| DA8XX_INTR_RX_MASK
);
110 musb_writel(reg_base
, DA8XX_USB_END_OF_INTR_REG
, 0);
113 #define portstate(stmt) stmt
115 static void da8xx_musb_set_vbus(struct musb
*musb
, int is_on
)
117 WARN_ON(is_on
&& is_peripheral_active(musb
));
120 #define POLL_SECONDS 2
122 static void otg_timer(struct timer_list
*t
)
124 struct musb
*musb
= from_timer(musb
, t
, dev_timer
);
125 void __iomem
*mregs
= musb
->mregs
;
130 * We poll because DaVinci's won't expose several OTG-critical
131 * status change events (from the transceiver) otherwise.
133 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
134 dev_dbg(musb
->controller
, "Poll devctl %02x (%s)\n", devctl
,
135 usb_otg_state_string(musb
->xceiv
->otg
->state
));
137 spin_lock_irqsave(&musb
->lock
, flags
);
138 switch (musb
->xceiv
->otg
->state
) {
139 case OTG_STATE_A_WAIT_BCON
:
140 devctl
&= ~MUSB_DEVCTL_SESSION
;
141 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
143 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
144 if (devctl
& MUSB_DEVCTL_BDEVICE
) {
145 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
148 musb
->xceiv
->otg
->state
= OTG_STATE_A_IDLE
;
152 case OTG_STATE_A_WAIT_VFALL
:
154 * Wait till VBUS falls below SessionEnd (~0.2 V); the 1.3
155 * RTL seems to mis-handle session "start" otherwise (or in
156 * our case "recover"), in routine "VBUS was valid by the time
157 * VBUSERR got reported during enumeration" cases.
159 if (devctl
& MUSB_DEVCTL_VBUS
) {
160 mod_timer(&musb
->dev_timer
, jiffies
+ POLL_SECONDS
* HZ
);
163 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VRISE
;
164 musb_writel(musb
->ctrl_base
, DA8XX_USB_INTR_SRC_SET_REG
,
165 MUSB_INTR_VBUSERROR
<< DA8XX_INTR_USB_SHIFT
);
167 case OTG_STATE_B_IDLE
:
169 * There's no ID-changed IRQ, so we have no good way to tell
170 * when to switch to the A-Default state machine (by setting
171 * the DEVCTL.Session bit).
173 * Workaround: whenever we're in B_IDLE, try setting the
174 * session flag every few seconds. If it works, ID was
175 * grounded and we're now in the A-Default state machine.
177 * NOTE: setting the session flag is _supposed_ to trigger
178 * SRP but clearly it doesn't.
180 musb_writeb(mregs
, MUSB_DEVCTL
, devctl
| MUSB_DEVCTL_SESSION
);
181 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
182 if (devctl
& MUSB_DEVCTL_BDEVICE
)
183 mod_timer(&musb
->dev_timer
, jiffies
+ POLL_SECONDS
* HZ
);
185 musb
->xceiv
->otg
->state
= OTG_STATE_A_IDLE
;
190 spin_unlock_irqrestore(&musb
->lock
, flags
);
193 static void da8xx_musb_try_idle(struct musb
*musb
, unsigned long timeout
)
195 static unsigned long last_timer
;
198 timeout
= jiffies
+ msecs_to_jiffies(3);
200 /* Never idle if active, or when VBUS timeout is not set as host */
201 if (musb
->is_active
|| (musb
->a_wait_bcon
== 0 &&
202 musb
->xceiv
->otg
->state
== OTG_STATE_A_WAIT_BCON
)) {
203 dev_dbg(musb
->controller
, "%s active, deleting timer\n",
204 usb_otg_state_string(musb
->xceiv
->otg
->state
));
205 del_timer(&musb
->dev_timer
);
206 last_timer
= jiffies
;
210 if (time_after(last_timer
, timeout
) && timer_pending(&musb
->dev_timer
)) {
211 dev_dbg(musb
->controller
, "Longer idle timer already pending, ignoring...\n");
214 last_timer
= timeout
;
216 dev_dbg(musb
->controller
, "%s inactive, starting idle timer for %u ms\n",
217 usb_otg_state_string(musb
->xceiv
->otg
->state
),
218 jiffies_to_msecs(timeout
- jiffies
));
219 mod_timer(&musb
->dev_timer
, timeout
);
222 static irqreturn_t
da8xx_musb_interrupt(int irq
, void *hci
)
224 struct musb
*musb
= hci
;
225 void __iomem
*reg_base
= musb
->ctrl_base
;
226 struct usb_otg
*otg
= musb
->xceiv
->otg
;
228 irqreturn_t ret
= IRQ_NONE
;
231 spin_lock_irqsave(&musb
->lock
, flags
);
234 * NOTE: DA8XX shadows the Mentor IRQs. Don't manage them through
235 * the Mentor registers (except for setup), use the TI ones and EOI.
238 /* Acknowledge and handle non-CPPI interrupts */
239 status
= musb_readl(reg_base
, DA8XX_USB_INTR_SRC_MASKED_REG
);
243 musb_writel(reg_base
, DA8XX_USB_INTR_SRC_CLEAR_REG
, status
);
244 dev_dbg(musb
->controller
, "USB IRQ %08x\n", status
);
246 musb
->int_rx
= (status
& DA8XX_INTR_RX_MASK
) >> DA8XX_INTR_RX_SHIFT
;
247 musb
->int_tx
= (status
& DA8XX_INTR_TX_MASK
) >> DA8XX_INTR_TX_SHIFT
;
248 musb
->int_usb
= (status
& DA8XX_INTR_USB_MASK
) >> DA8XX_INTR_USB_SHIFT
;
251 * DRVVBUS IRQs are the only proxy we have (a very poor one!) for
252 * DA8xx's missing ID change IRQ. We need an ID change IRQ to
253 * switch appropriately between halves of the OTG state machine.
254 * Managing DEVCTL.Session per Mentor docs requires that we know its
255 * value but DEVCTL.BDevice is invalid without DEVCTL.Session set.
256 * Also, DRVVBUS pulses for SRP (but not at 5 V)...
258 if (status
& (DA8XX_INTR_DRVVBUS
<< DA8XX_INTR_USB_SHIFT
)) {
259 int drvvbus
= musb_readl(reg_base
, DA8XX_USB_STAT_REG
);
260 void __iomem
*mregs
= musb
->mregs
;
261 u8 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
264 err
= musb
->int_usb
& MUSB_INTR_VBUSERROR
;
267 * The Mentor core doesn't debounce VBUS as needed
268 * to cope with device connect current spikes. This
269 * means it's not uncommon for bus-powered devices
270 * to get VBUS errors during enumeration.
272 * This is a workaround, but newer RTL from Mentor
273 * seems to allow a better one: "re"-starting sessions
274 * without waiting for VBUS to stop registering in
277 musb
->int_usb
&= ~MUSB_INTR_VBUSERROR
;
278 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VFALL
;
279 mod_timer(&musb
->dev_timer
, jiffies
+ POLL_SECONDS
* HZ
);
280 WARNING("VBUS error workaround (delay coming)\n");
281 } else if (drvvbus
) {
284 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VRISE
;
285 portstate(musb
->port1_status
|= USB_PORT_STAT_POWER
);
286 del_timer(&musb
->dev_timer
);
291 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
292 portstate(musb
->port1_status
&= ~USB_PORT_STAT_POWER
);
295 dev_dbg(musb
->controller
, "VBUS %s (%s)%s, devctl %02x\n",
296 drvvbus
? "on" : "off",
297 usb_otg_state_string(musb
->xceiv
->otg
->state
),
303 if (musb
->int_tx
|| musb
->int_rx
|| musb
->int_usb
)
304 ret
|= musb_interrupt(musb
);
307 /* EOI needs to be written for the IRQ to be re-asserted. */
308 if (ret
== IRQ_HANDLED
|| status
)
309 musb_writel(reg_base
, DA8XX_USB_END_OF_INTR_REG
, 0);
311 /* Poll for ID change */
312 if (musb
->xceiv
->otg
->state
== OTG_STATE_B_IDLE
)
313 mod_timer(&musb
->dev_timer
, jiffies
+ POLL_SECONDS
* HZ
);
315 spin_unlock_irqrestore(&musb
->lock
, flags
);
320 static int da8xx_musb_set_mode(struct musb
*musb
, u8 musb_mode
)
322 struct da8xx_glue
*glue
= dev_get_drvdata(musb
->controller
->parent
);
323 enum phy_mode phy_mode
;
326 * The PHY has some issues when it is forced in device or host mode.
327 * Unless the user request another mode, configure the PHY in OTG mode.
329 if (!musb
->is_initialized
)
330 return phy_set_mode(glue
->phy
, PHY_MODE_USB_OTG
);
333 case MUSB_HOST
: /* Force VBUS valid, ID = 0 */
334 phy_mode
= PHY_MODE_USB_HOST
;
336 case MUSB_PERIPHERAL
: /* Force VBUS valid, ID = 1 */
337 phy_mode
= PHY_MODE_USB_DEVICE
;
339 case MUSB_OTG
: /* Don't override the VBUS/ID comparators */
340 phy_mode
= PHY_MODE_USB_OTG
;
346 return phy_set_mode(glue
->phy
, phy_mode
);
349 static int da8xx_musb_init(struct musb
*musb
)
351 struct da8xx_glue
*glue
= dev_get_drvdata(musb
->controller
->parent
);
352 void __iomem
*reg_base
= musb
->ctrl_base
;
356 musb
->mregs
+= DA8XX_MENTOR_CORE_OFFSET
;
358 ret
= clk_prepare_enable(glue
->clk
);
360 dev_err(glue
->dev
, "failed to enable clock\n");
364 /* Returns zero if e.g. not clocked */
365 rev
= musb_readl(reg_base
, DA8XX_USB_REVISION_REG
);
369 musb
->xceiv
= usb_get_phy(USB_PHY_TYPE_USB2
);
370 if (IS_ERR_OR_NULL(musb
->xceiv
)) {
375 timer_setup(&musb
->dev_timer
, otg_timer
, 0);
377 /* Reset the controller */
378 musb_writel(reg_base
, DA8XX_USB_CTRL_REG
, DA8XX_SOFT_RESET_MASK
);
380 /* Start the on-chip PHY and its PLL. */
381 ret
= phy_init(glue
->phy
);
383 dev_err(glue
->dev
, "Failed to init phy.\n");
387 ret
= phy_power_on(glue
->phy
);
389 dev_err(glue
->dev
, "Failed to power on phy.\n");
390 goto err_phy_power_on
;
395 /* NOTE: IRQs are in mixed mode, not bypass to pure MUSB */
396 pr_debug("DA8xx OTG revision %08x, control %02x\n", rev
,
397 musb_readb(reg_base
, DA8XX_USB_CTRL_REG
));
399 musb
->isr
= da8xx_musb_interrupt
;
405 clk_disable_unprepare(glue
->clk
);
409 static int da8xx_musb_exit(struct musb
*musb
)
411 struct da8xx_glue
*glue
= dev_get_drvdata(musb
->controller
->parent
);
413 del_timer_sync(&musb
->dev_timer
);
415 phy_power_off(glue
->phy
);
417 clk_disable_unprepare(glue
->clk
);
419 usb_put_phy(musb
->xceiv
);
424 static inline u8
get_vbus_power(struct device
*dev
)
426 struct regulator
*vbus_supply
;
429 vbus_supply
= regulator_get_optional(dev
, "vbus");
430 if (IS_ERR(vbus_supply
))
432 current_uA
= regulator_get_current_limit(vbus_supply
);
433 regulator_put(vbus_supply
);
434 if (current_uA
<= 0 || current_uA
> 510000)
436 return current_uA
/ 1000 / 2;
439 #ifdef CONFIG_USB_TI_CPPI41_DMA
440 static void da8xx_dma_controller_callback(struct dma_controller
*c
)
442 struct musb
*musb
= c
->musb
;
443 void __iomem
*reg_base
= musb
->ctrl_base
;
445 musb_writel(reg_base
, DA8XX_USB_END_OF_INTR_REG
, 0);
448 static struct dma_controller
*
449 da8xx_dma_controller_create(struct musb
*musb
, void __iomem
*base
)
451 struct dma_controller
*controller
;
453 controller
= cppi41_dma_controller_create(musb
, base
);
454 if (IS_ERR_OR_NULL(controller
))
457 controller
->dma_callback
= da8xx_dma_controller_callback
;
463 static const struct musb_platform_ops da8xx_ops
= {
464 .quirks
= MUSB_INDEXED_EP
| MUSB_PRESERVE_SESSION
|
465 MUSB_DMA_CPPI41
| MUSB_DA8XX
,
466 .init
= da8xx_musb_init
,
467 .exit
= da8xx_musb_exit
,
470 #ifdef CONFIG_USB_TI_CPPI41_DMA
471 .dma_init
= da8xx_dma_controller_create
,
472 .dma_exit
= cppi41_dma_controller_destroy
,
474 .enable
= da8xx_musb_enable
,
475 .disable
= da8xx_musb_disable
,
477 .set_mode
= da8xx_musb_set_mode
,
478 .try_idle
= da8xx_musb_try_idle
,
480 .set_vbus
= da8xx_musb_set_vbus
,
483 static const struct platform_device_info da8xx_dev_info
= {
485 .id
= PLATFORM_DEVID_AUTO
,
486 .dma_mask
= DMA_BIT_MASK(32),
489 static const struct musb_hdrc_config da8xx_config
= {
495 static struct of_dev_auxdata da8xx_auxdata_lookup
[] = {
496 OF_DEV_AUXDATA("ti,da830-cppi41", 0x01e01000, "cppi41-dmaengine",
501 static int da8xx_probe(struct platform_device
*pdev
)
503 struct resource musb_resources
[2];
504 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
505 struct da8xx_glue
*glue
;
506 struct platform_device_info pinfo
;
508 struct device_node
*np
= pdev
->dev
.of_node
;
511 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
515 clk
= devm_clk_get(&pdev
->dev
, "usb20");
517 dev_err(&pdev
->dev
, "failed to get clock\n");
521 glue
->phy
= devm_phy_get(&pdev
->dev
, "usb-phy");
522 if (IS_ERR(glue
->phy
)) {
523 if (PTR_ERR(glue
->phy
) != -EPROBE_DEFER
)
524 dev_err(&pdev
->dev
, "failed to get phy\n");
525 return PTR_ERR(glue
->phy
);
528 glue
->dev
= &pdev
->dev
;
531 if (IS_ENABLED(CONFIG_OF
) && np
) {
532 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
536 pdata
->config
= &da8xx_config
;
537 pdata
->mode
= musb_get_mode(&pdev
->dev
);
538 pdata
->power
= get_vbus_power(&pdev
->dev
);
541 pdata
->platform_ops
= &da8xx_ops
;
543 glue
->usb_phy
= usb_phy_generic_register();
544 ret
= PTR_ERR_OR_ZERO(glue
->usb_phy
);
546 dev_err(&pdev
->dev
, "failed to register usb_phy\n");
549 platform_set_drvdata(pdev
, glue
);
551 ret
= of_platform_populate(pdev
->dev
.of_node
, NULL
,
552 da8xx_auxdata_lookup
, &pdev
->dev
);
556 memset(musb_resources
, 0x00, sizeof(*musb_resources
) *
557 ARRAY_SIZE(musb_resources
));
559 musb_resources
[0].name
= pdev
->resource
[0].name
;
560 musb_resources
[0].start
= pdev
->resource
[0].start
;
561 musb_resources
[0].end
= pdev
->resource
[0].end
;
562 musb_resources
[0].flags
= pdev
->resource
[0].flags
;
564 musb_resources
[1].name
= pdev
->resource
[1].name
;
565 musb_resources
[1].start
= pdev
->resource
[1].start
;
566 musb_resources
[1].end
= pdev
->resource
[1].end
;
567 musb_resources
[1].flags
= pdev
->resource
[1].flags
;
569 pinfo
= da8xx_dev_info
;
570 pinfo
.parent
= &pdev
->dev
;
571 pinfo
.res
= musb_resources
;
572 pinfo
.num_res
= ARRAY_SIZE(musb_resources
);
574 pinfo
.size_data
= sizeof(*pdata
);
576 glue
->musb
= platform_device_register_full(&pinfo
);
577 ret
= PTR_ERR_OR_ZERO(glue
->musb
);
579 dev_err(&pdev
->dev
, "failed to register musb device: %d\n", ret
);
580 usb_phy_generic_unregister(glue
->usb_phy
);
586 static int da8xx_remove(struct platform_device
*pdev
)
588 struct da8xx_glue
*glue
= platform_get_drvdata(pdev
);
590 platform_device_unregister(glue
->musb
);
591 usb_phy_generic_unregister(glue
->usb_phy
);
596 #ifdef CONFIG_PM_SLEEP
597 static int da8xx_suspend(struct device
*dev
)
600 struct da8xx_glue
*glue
= dev_get_drvdata(dev
);
602 ret
= phy_power_off(glue
->phy
);
605 clk_disable_unprepare(glue
->clk
);
610 static int da8xx_resume(struct device
*dev
)
613 struct da8xx_glue
*glue
= dev_get_drvdata(dev
);
615 ret
= clk_prepare_enable(glue
->clk
);
618 return phy_power_on(glue
->phy
);
622 static SIMPLE_DEV_PM_OPS(da8xx_pm_ops
, da8xx_suspend
, da8xx_resume
);
625 static const struct of_device_id da8xx_id_table
[] = {
627 .compatible
= "ti,da830-musb",
631 MODULE_DEVICE_TABLE(of
, da8xx_id_table
);
634 static struct platform_driver da8xx_driver
= {
635 .probe
= da8xx_probe
,
636 .remove
= da8xx_remove
,
638 .name
= "musb-da8xx",
640 .of_match_table
= of_match_ptr(da8xx_id_table
),
644 MODULE_DESCRIPTION("DA8xx/OMAP-L1x MUSB Glue Layer");
645 MODULE_AUTHOR("Sergei Shtylyov <sshtylyov@ru.mvista.com>");
646 MODULE_LICENSE("GPL v2");
647 module_platform_driver(da8xx_driver
);