xref: /openbmc/u-boot/drivers/usb/musb-new/omap2430.c (revision a22bbfda)
1 /*
2  * Copyright (C) 2005-2007 by Texas Instruments
3  * Some code has been taken from tusb6010.c
4  * Copyrights for that are attributable to:
5  * Copyright (C) 2006 Nokia Corporation
6  * Tony Lindgren <tony@atomide.com>
7  *
8  * This file is part of the Inventra Controller Driver for Linux.
9  *
10  * SPDX-License-Identifier:	GPL-2.0
11  */
12 #ifndef __UBOOT__
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/sched.h>
16 #include <linux/init.h>
17 #include <linux/list.h>
18 #include <linux/io.h>
19 #include <linux/platform_device.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/err.h>
23 #include <linux/usb/musb-omap.h>
24 #else
25 #include <common.h>
26 #include <asm/omap_common.h>
27 #include <asm/omap_musb.h>
28 #include <twl4030.h>
29 #include <twl6030.h>
30 #include "linux-compat.h"
31 #endif
32 
33 #include "musb_core.h"
34 #include "omap2430.h"
35 
36 #ifndef __UBOOT__
37 struct omap2430_glue {
38 	struct device		*dev;
39 	struct platform_device	*musb;
40 	enum omap_musb_vbus_id_status status;
41 	struct work_struct	omap_musb_mailbox_work;
42 };
43 #define glue_to_musb(g)		platform_get_drvdata(g->musb)
44 
45 struct omap2430_glue		*_glue;
46 
47 static struct timer_list musb_idle_timer;
48 
49 static void musb_do_idle(unsigned long _musb)
50 {
51 	struct musb	*musb = (void *)_musb;
52 	unsigned long	flags;
53 	u8	power;
54 	u8	devctl;
55 
56 	spin_lock_irqsave(&musb->lock, flags);
57 
58 	switch (musb->xceiv->state) {
59 	case OTG_STATE_A_WAIT_BCON:
60 
61 		devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
62 		if (devctl & MUSB_DEVCTL_BDEVICE) {
63 			musb->xceiv->state = OTG_STATE_B_IDLE;
64 			MUSB_DEV_MODE(musb);
65 		} else {
66 			musb->xceiv->state = OTG_STATE_A_IDLE;
67 			MUSB_HST_MODE(musb);
68 		}
69 		break;
70 	case OTG_STATE_A_SUSPEND:
71 		/* finish RESUME signaling? */
72 		if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
73 			power = musb_readb(musb->mregs, MUSB_POWER);
74 			power &= ~MUSB_POWER_RESUME;
75 			dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
76 			musb_writeb(musb->mregs, MUSB_POWER, power);
77 			musb->is_active = 1;
78 			musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
79 						| MUSB_PORT_STAT_RESUME);
80 			musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
81 			usb_hcd_poll_rh_status(musb_to_hcd(musb));
82 			/* NOTE: it might really be A_WAIT_BCON ... */
83 			musb->xceiv->state = OTG_STATE_A_HOST;
84 		}
85 		break;
86 	case OTG_STATE_A_HOST:
87 		devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
88 		if (devctl &  MUSB_DEVCTL_BDEVICE)
89 			musb->xceiv->state = OTG_STATE_B_IDLE;
90 		else
91 			musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
92 	default:
93 		break;
94 	}
95 	spin_unlock_irqrestore(&musb->lock, flags);
96 }
97 
98 
99 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
100 {
101 	unsigned long		default_timeout = jiffies + msecs_to_jiffies(3);
102 	static unsigned long	last_timer;
103 
104 	if (timeout == 0)
105 		timeout = default_timeout;
106 
107 	/* Never idle if active, or when VBUS timeout is not set as host */
108 	if (musb->is_active || ((musb->a_wait_bcon == 0)
109 			&& (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
110 		dev_dbg(musb->controller, "%s active, deleting timer\n",
111 			otg_state_string(musb->xceiv->state));
112 		del_timer(&musb_idle_timer);
113 		last_timer = jiffies;
114 		return;
115 	}
116 
117 	if (time_after(last_timer, timeout)) {
118 		if (!timer_pending(&musb_idle_timer))
119 			last_timer = timeout;
120 		else {
121 			dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
122 			return;
123 		}
124 	}
125 	last_timer = timeout;
126 
127 	dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
128 		otg_state_string(musb->xceiv->state),
129 		(unsigned long)jiffies_to_msecs(timeout - jiffies));
130 	mod_timer(&musb_idle_timer, timeout);
131 }
132 
133 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
134 {
135 	struct usb_otg	*otg = musb->xceiv->otg;
136 	u8		devctl;
137 	unsigned long timeout = jiffies + msecs_to_jiffies(1000);
138 	int ret = 1;
139 	/* HDRC controls CPEN, but beware current surges during device
140 	 * connect.  They can trigger transient overcurrent conditions
141 	 * that must be ignored.
142 	 */
143 
144 	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
145 
146 	if (is_on) {
147 		if (musb->xceiv->state == OTG_STATE_A_IDLE) {
148 			/* start the session */
149 			devctl |= MUSB_DEVCTL_SESSION;
150 			musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
151 			/*
152 			 * Wait for the musb to set as A device to enable the
153 			 * VBUS
154 			 */
155 			while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
156 
157 				cpu_relax();
158 
159 				if (time_after(jiffies, timeout)) {
160 					dev_err(musb->controller,
161 					"configured as A device timeout");
162 					ret = -EINVAL;
163 					break;
164 				}
165 			}
166 
167 			if (ret && otg->set_vbus)
168 				otg_set_vbus(otg, 1);
169 		} else {
170 			musb->is_active = 1;
171 			otg->default_a = 1;
172 			musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
173 			devctl |= MUSB_DEVCTL_SESSION;
174 			MUSB_HST_MODE(musb);
175 		}
176 	} else {
177 		musb->is_active = 0;
178 
179 		/* NOTE:  we're skipping A_WAIT_VFALL -> A_IDLE and
180 		 * jumping right to B_IDLE...
181 		 */
182 
183 		otg->default_a = 0;
184 		musb->xceiv->state = OTG_STATE_B_IDLE;
185 		devctl &= ~MUSB_DEVCTL_SESSION;
186 
187 		MUSB_DEV_MODE(musb);
188 	}
189 	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
190 
191 	dev_dbg(musb->controller, "VBUS %s, devctl %02x "
192 		/* otg %3x conf %08x prcm %08x */ "\n",
193 		otg_state_string(musb->xceiv->state),
194 		musb_readb(musb->mregs, MUSB_DEVCTL));
195 }
196 
197 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
198 {
199 	u8	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
200 
201 	devctl |= MUSB_DEVCTL_SESSION;
202 	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
203 
204 	return 0;
205 }
206 #endif
207 
208 static inline void omap2430_low_level_exit(struct musb *musb)
209 {
210 	u32 l;
211 
212 	/* in any role */
213 	l = musb_readl(musb->mregs, OTG_FORCESTDBY);
214 	l |= ENABLEFORCE;	/* enable MSTANDBY */
215 	musb_writel(musb->mregs, OTG_FORCESTDBY, l);
216 }
217 
218 static inline void omap2430_low_level_init(struct musb *musb)
219 {
220 	u32 l;
221 
222 	l = musb_readl(musb->mregs, OTG_FORCESTDBY);
223 	l &= ~ENABLEFORCE;	/* disable MSTANDBY */
224 	musb_writel(musb->mregs, OTG_FORCESTDBY, l);
225 }
226 
227 #ifndef __UBOOT__
228 void omap_musb_mailbox(enum omap_musb_vbus_id_status status)
229 {
230 	struct omap2430_glue	*glue = _glue;
231 	struct musb		*musb = glue_to_musb(glue);
232 
233 	glue->status = status;
234 	if (!musb) {
235 		dev_err(glue->dev, "musb core is not yet ready\n");
236 		return;
237 	}
238 
239 	schedule_work(&glue->omap_musb_mailbox_work);
240 }
241 EXPORT_SYMBOL_GPL(omap_musb_mailbox);
242 
243 static void omap_musb_set_mailbox(struct omap2430_glue *glue)
244 {
245 	struct musb *musb = glue_to_musb(glue);
246 	struct device *dev = musb->controller;
247 	struct musb_hdrc_platform_data *pdata = dev->platform_data;
248 	struct omap_musb_board_data *data = pdata->board_data;
249 	struct usb_otg *otg = musb->xceiv->otg;
250 
251 	switch (glue->status) {
252 	case OMAP_MUSB_ID_GROUND:
253 		dev_dbg(dev, "ID GND\n");
254 
255 		otg->default_a = true;
256 		musb->xceiv->state = OTG_STATE_A_IDLE;
257 		musb->xceiv->last_event = USB_EVENT_ID;
258 		if (!is_otg_enabled(musb) || musb->gadget_driver) {
259 			pm_runtime_get_sync(dev);
260 			usb_phy_init(musb->xceiv);
261 			omap2430_musb_set_vbus(musb, 1);
262 		}
263 		break;
264 
265 	case OMAP_MUSB_VBUS_VALID:
266 		dev_dbg(dev, "VBUS Connect\n");
267 
268 		otg->default_a = false;
269 		musb->xceiv->state = OTG_STATE_B_IDLE;
270 		musb->xceiv->last_event = USB_EVENT_VBUS;
271 		if (musb->gadget_driver)
272 			pm_runtime_get_sync(dev);
273 		usb_phy_init(musb->xceiv);
274 		break;
275 
276 	case OMAP_MUSB_ID_FLOAT:
277 	case OMAP_MUSB_VBUS_OFF:
278 		dev_dbg(dev, "VBUS Disconnect\n");
279 
280 		musb->xceiv->last_event = USB_EVENT_NONE;
281 		if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
282 			if (musb->gadget_driver) {
283 				pm_runtime_mark_last_busy(dev);
284 				pm_runtime_put_autosuspend(dev);
285 			}
286 
287 		if (data->interface_type == MUSB_INTERFACE_UTMI) {
288 			if (musb->xceiv->otg->set_vbus)
289 				otg_set_vbus(musb->xceiv->otg, 0);
290 		}
291 		usb_phy_shutdown(musb->xceiv);
292 		break;
293 	default:
294 		dev_dbg(dev, "ID float\n");
295 	}
296 }
297 
298 
299 static void omap_musb_mailbox_work(struct work_struct *mailbox_work)
300 {
301 	struct omap2430_glue *glue = container_of(mailbox_work,
302 				struct omap2430_glue, omap_musb_mailbox_work);
303 	omap_musb_set_mailbox(glue);
304 }
305 #endif
306 
307 static int omap2430_musb_init(struct musb *musb)
308 {
309 	u32 l;
310 	int status = 0;
311 	unsigned long int start;
312 #ifndef __UBOOT__
313 	struct device *dev = musb->controller;
314 	struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
315 	struct musb_hdrc_platform_data *plat = dev->platform_data;
316 	struct omap_musb_board_data *data = plat->board_data;
317 #else
318 	struct omap_musb_board_data *data =
319 		(struct omap_musb_board_data *)musb->controller;
320 #endif
321 
322 	/* Reset the controller */
323 	musb_writel(musb->mregs, OTG_SYSCONFIG, SOFTRST);
324 
325 	start = get_timer(0);
326 
327 	while (1) {
328 		l = musb_readl(musb->mregs, OTG_SYSCONFIG);
329 		if ((l & SOFTRST) == 0)
330 			break;
331 
332 		if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
333 			dev_err(musb->controller, "MUSB reset is taking too long\n");
334 			return -ENODEV;
335 		}
336 	}
337 
338 #ifndef __UBOOT__
339 	/* We require some kind of external transceiver, hooked
340 	 * up through ULPI.  TWL4030-family PMICs include one,
341 	 * which needs a driver, drivers aren't always needed.
342 	 */
343 	musb->xceiv = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
344 	if (IS_ERR_OR_NULL(musb->xceiv)) {
345 		pr_err("HS USB OTG: no transceiver configured\n");
346 		return -ENODEV;
347 	}
348 
349 	status = pm_runtime_get_sync(dev);
350 	if (status < 0) {
351 		dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
352 		goto err1;
353 	}
354 #endif
355 
356 	l = musb_readl(musb->mregs, OTG_INTERFSEL);
357 
358 	if (data->interface_type == MUSB_INTERFACE_UTMI) {
359 		/* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
360 		l &= ~ULPI_12PIN;       /* Disable ULPI */
361 		l |= UTMI_8BIT;         /* Enable UTMI  */
362 	} else {
363 		l |= ULPI_12PIN;
364 	}
365 
366 	musb_writel(musb->mregs, OTG_INTERFSEL, l);
367 
368 	pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
369 			"sysstatus 0x%x, intrfsel 0x%x, simenable  0x%x\n",
370 			musb_readl(musb->mregs, OTG_REVISION),
371 			musb_readl(musb->mregs, OTG_SYSCONFIG),
372 			musb_readl(musb->mregs, OTG_SYSSTATUS),
373 			musb_readl(musb->mregs, OTG_INTERFSEL),
374 			musb_readl(musb->mregs, OTG_SIMENABLE));
375 
376 #ifndef __UBOOT__
377 	setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
378 
379 	if (glue->status != OMAP_MUSB_UNKNOWN)
380 		omap_musb_set_mailbox(glue);
381 
382 	pm_runtime_put_noidle(musb->controller);
383 #endif
384 	return 0;
385 
386 err1:
387 	return status;
388 }
389 
390 #ifndef __UBOOT__
391 static void omap2430_musb_enable(struct musb *musb)
392 #else
393 static int omap2430_musb_enable(struct musb *musb)
394 #endif
395 {
396 #ifndef __UBOOT__
397 	u8		devctl;
398 	unsigned long timeout = jiffies + msecs_to_jiffies(1000);
399 	struct device *dev = musb->controller;
400 	struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
401 	struct musb_hdrc_platform_data *pdata = dev->platform_data;
402 	struct omap_musb_board_data *data = pdata->board_data;
403 
404 	switch (glue->status) {
405 
406 	case OMAP_MUSB_ID_GROUND:
407 		usb_phy_init(musb->xceiv);
408 		if (data->interface_type != MUSB_INTERFACE_UTMI)
409 			break;
410 		devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
411 		/* start the session */
412 		devctl |= MUSB_DEVCTL_SESSION;
413 		musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
414 		while (musb_readb(musb->mregs, MUSB_DEVCTL) &
415 				MUSB_DEVCTL_BDEVICE) {
416 			cpu_relax();
417 
418 			if (time_after(jiffies, timeout)) {
419 				dev_err(dev, "configured as A device timeout");
420 				break;
421 			}
422 		}
423 		break;
424 
425 	case OMAP_MUSB_VBUS_VALID:
426 		usb_phy_init(musb->xceiv);
427 		break;
428 
429 	default:
430 		break;
431 	}
432 #else
433 #ifdef CONFIG_TWL4030_USB
434 	if (twl4030_usb_ulpi_init()) {
435 		serial_printf("ERROR: %s Could not initialize PHY\n",
436 				__PRETTY_FUNCTION__);
437 	}
438 #endif
439 
440 #ifdef CONFIG_TWL6030_POWER
441 	twl6030_usb_device_settings();
442 #endif
443 
444 #ifdef CONFIG_OMAP44XX
445 	u32 *usbotghs_control = (u32 *)((*ctrl)->control_usbotghs_ctrl);
446 	*usbotghs_control = USBOTGHS_CONTROL_AVALID |
447 		USBOTGHS_CONTROL_VBUSVALID | USBOTGHS_CONTROL_IDDIG;
448 #endif
449 
450 	return 0;
451 #endif
452 }
453 
454 static void omap2430_musb_disable(struct musb *musb)
455 {
456 #ifndef __UBOOT__
457 	struct device *dev = musb->controller;
458 	struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
459 
460 	if (glue->status != OMAP_MUSB_UNKNOWN)
461 		usb_phy_shutdown(musb->xceiv);
462 #endif
463 }
464 
465 static int omap2430_musb_exit(struct musb *musb)
466 {
467 	del_timer_sync(&musb_idle_timer);
468 
469 	omap2430_low_level_exit(musb);
470 
471 	return 0;
472 }
473 
474 #ifndef __UBOOT__
475 static const struct musb_platform_ops omap2430_ops = {
476 #else
477 const struct musb_platform_ops omap2430_ops = {
478 #endif
479 	.init		= omap2430_musb_init,
480 	.exit		= omap2430_musb_exit,
481 
482 #ifndef __UBOOT__
483 	.set_mode	= omap2430_musb_set_mode,
484 	.try_idle	= omap2430_musb_try_idle,
485 
486 	.set_vbus	= omap2430_musb_set_vbus,
487 #endif
488 
489 	.enable		= omap2430_musb_enable,
490 	.disable	= omap2430_musb_disable,
491 };
492 
493 #ifndef __UBOOT__
494 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
495 
496 static int __devinit omap2430_probe(struct platform_device *pdev)
497 {
498 	struct musb_hdrc_platform_data	*pdata = pdev->dev.platform_data;
499 	struct platform_device		*musb;
500 	struct omap2430_glue		*glue;
501 	int				ret = -ENOMEM;
502 
503 	glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
504 	if (!glue) {
505 		dev_err(&pdev->dev, "failed to allocate glue context\n");
506 		goto err0;
507 	}
508 
509 	musb = platform_device_alloc("musb-hdrc", -1);
510 	if (!musb) {
511 		dev_err(&pdev->dev, "failed to allocate musb device\n");
512 		goto err0;
513 	}
514 
515 	musb->dev.parent		= &pdev->dev;
516 	musb->dev.dma_mask		= &omap2430_dmamask;
517 	musb->dev.coherent_dma_mask	= omap2430_dmamask;
518 
519 	glue->dev			= &pdev->dev;
520 	glue->musb			= musb;
521 	glue->status			= OMAP_MUSB_UNKNOWN;
522 
523 	pdata->platform_ops		= &omap2430_ops;
524 
525 	platform_set_drvdata(pdev, glue);
526 
527 	/*
528 	 * REVISIT if we ever have two instances of the wrapper, we will be
529 	 * in big trouble
530 	 */
531 	_glue	= glue;
532 
533 	INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
534 
535 	ret = platform_device_add_resources(musb, pdev->resource,
536 			pdev->num_resources);
537 	if (ret) {
538 		dev_err(&pdev->dev, "failed to add resources\n");
539 		goto err1;
540 	}
541 
542 	ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
543 	if (ret) {
544 		dev_err(&pdev->dev, "failed to add platform_data\n");
545 		goto err1;
546 	}
547 
548 	pm_runtime_enable(&pdev->dev);
549 
550 	ret = platform_device_add(musb);
551 	if (ret) {
552 		dev_err(&pdev->dev, "failed to register musb device\n");
553 		goto err1;
554 	}
555 
556 	return 0;
557 
558 err1:
559 	platform_device_put(musb);
560 
561 err0:
562 	return ret;
563 }
564 
565 static int __devexit omap2430_remove(struct platform_device *pdev)
566 {
567 	struct omap2430_glue		*glue = platform_get_drvdata(pdev);
568 
569 	cancel_work_sync(&glue->omap_musb_mailbox_work);
570 	platform_device_del(glue->musb);
571 	platform_device_put(glue->musb);
572 
573 	return 0;
574 }
575 
576 #ifdef CONFIG_PM
577 
578 static int omap2430_runtime_suspend(struct device *dev)
579 {
580 	struct omap2430_glue		*glue = dev_get_drvdata(dev);
581 	struct musb			*musb = glue_to_musb(glue);
582 
583 	if (musb) {
584 		musb->context.otg_interfsel = musb_readl(musb->mregs,
585 				OTG_INTERFSEL);
586 
587 		omap2430_low_level_exit(musb);
588 		usb_phy_set_suspend(musb->xceiv, 1);
589 	}
590 
591 	return 0;
592 }
593 
594 static int omap2430_runtime_resume(struct device *dev)
595 {
596 	struct omap2430_glue		*glue = dev_get_drvdata(dev);
597 	struct musb			*musb = glue_to_musb(glue);
598 
599 	if (musb) {
600 		omap2430_low_level_init(musb);
601 		musb_writel(musb->mregs, OTG_INTERFSEL,
602 				musb->context.otg_interfsel);
603 
604 		usb_phy_set_suspend(musb->xceiv, 0);
605 	}
606 
607 	return 0;
608 }
609 
610 static struct dev_pm_ops omap2430_pm_ops = {
611 	.runtime_suspend = omap2430_runtime_suspend,
612 	.runtime_resume = omap2430_runtime_resume,
613 };
614 
615 #define DEV_PM_OPS	(&omap2430_pm_ops)
616 #else
617 #define DEV_PM_OPS	NULL
618 #endif
619 
620 static struct platform_driver omap2430_driver = {
621 	.probe		= omap2430_probe,
622 	.remove		= __devexit_p(omap2430_remove),
623 	.driver		= {
624 		.name	= "musb-omap2430",
625 		.pm	= DEV_PM_OPS,
626 	},
627 };
628 
629 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
630 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
631 MODULE_LICENSE("GPL v2");
632 
633 static int __init omap2430_init(void)
634 {
635 	return platform_driver_register(&omap2430_driver);
636 }
637 subsys_initcall(omap2430_init);
638 
639 static void __exit omap2430_exit(void)
640 {
641 	platform_driver_unregister(&omap2430_driver);
642 }
643 module_exit(omap2430_exit);
644 #endif
645