xref: /openbmc/linux/drivers/usb/musb/musb_dsps.c (revision d2ba09c1)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Texas Instruments DSPS platforms "glue layer"
4  *
5  * Copyright (C) 2012, by Texas Instruments
6  *
7  * Based on the am35x "glue layer" code.
8  *
9  * This file is part of the Inventra Controller Driver for Linux.
10  *
11  * musb_dsps.c will be a common file for all the TI DSPS platforms
12  * such as dm64x, dm36x, dm35x, da8x, am35x and ti81x.
13  * For now only ti81x is using this and in future davinci.c, am35x.c
14  * da8xx.c would be merged to this file after testing.
15  */
16 
17 #include <linux/io.h>
18 #include <linux/err.h>
19 #include <linux/platform_device.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/module.h>
23 #include <linux/usb/usb_phy_generic.h>
24 #include <linux/platform_data/usb-omap.h>
25 #include <linux/sizes.h>
26 
27 #include <linux/of.h>
28 #include <linux/of_device.h>
29 #include <linux/of_address.h>
30 #include <linux/of_irq.h>
31 #include <linux/usb/of.h>
32 
33 #include <linux/debugfs.h>
34 
35 #include "musb_core.h"
36 
37 static const struct of_device_id musb_dsps_of_match[];
38 
39 /**
40  * DSPS musb wrapper register offset.
41  * FIXME: This should be expanded to have all the wrapper registers from TI DSPS
42  * musb ips.
43  */
44 struct dsps_musb_wrapper {
45 	u16	revision;
46 	u16	control;
47 	u16	status;
48 	u16	epintr_set;
49 	u16	epintr_clear;
50 	u16	epintr_status;
51 	u16	coreintr_set;
52 	u16	coreintr_clear;
53 	u16	coreintr_status;
54 	u16	phy_utmi;
55 	u16	mode;
56 	u16	tx_mode;
57 	u16	rx_mode;
58 
59 	/* bit positions for control */
60 	unsigned	reset:5;
61 
62 	/* bit positions for interrupt */
63 	unsigned	usb_shift:5;
64 	u32		usb_mask;
65 	u32		usb_bitmap;
66 	unsigned	drvvbus:5;
67 
68 	unsigned	txep_shift:5;
69 	u32		txep_mask;
70 	u32		txep_bitmap;
71 
72 	unsigned	rxep_shift:5;
73 	u32		rxep_mask;
74 	u32		rxep_bitmap;
75 
76 	/* bit positions for phy_utmi */
77 	unsigned	otg_disable:5;
78 
79 	/* bit positions for mode */
80 	unsigned	iddig:5;
81 	unsigned	iddig_mux:5;
82 	/* miscellaneous stuff */
83 	unsigned	poll_timeout;
84 };
85 
86 /*
87  * register shadow for suspend
88  */
89 struct dsps_context {
90 	u32 control;
91 	u32 epintr;
92 	u32 coreintr;
93 	u32 phy_utmi;
94 	u32 mode;
95 	u32 tx_mode;
96 	u32 rx_mode;
97 };
98 
99 /**
100  * DSPS glue structure.
101  */
102 struct dsps_glue {
103 	struct device *dev;
104 	struct platform_device *musb;	/* child musb pdev */
105 	const struct dsps_musb_wrapper *wrp; /* wrapper register offsets */
106 	int vbus_irq;			/* optional vbus irq */
107 	unsigned long last_timer;    /* last timer data for each instance */
108 	bool sw_babble_enabled;
109 	void __iomem *usbss_base;
110 
111 	struct dsps_context context;
112 	struct debugfs_regset32 regset;
113 	struct dentry *dbgfs_root;
114 };
115 
116 static const struct debugfs_reg32 dsps_musb_regs[] = {
117 	{ "revision",		0x00 },
118 	{ "control",		0x14 },
119 	{ "status",		0x18 },
120 	{ "eoi",		0x24 },
121 	{ "intr0_stat",		0x30 },
122 	{ "intr1_stat",		0x34 },
123 	{ "intr0_set",		0x38 },
124 	{ "intr1_set",		0x3c },
125 	{ "txmode",		0x70 },
126 	{ "rxmode",		0x74 },
127 	{ "autoreq",		0xd0 },
128 	{ "srpfixtime",		0xd4 },
129 	{ "tdown",		0xd8 },
130 	{ "phy_utmi",		0xe0 },
131 	{ "mode",		0xe8 },
132 };
133 
134 static void dsps_mod_timer(struct dsps_glue *glue, int wait_ms)
135 {
136 	struct musb *musb = platform_get_drvdata(glue->musb);
137 	int wait;
138 
139 	if (wait_ms < 0)
140 		wait = msecs_to_jiffies(glue->wrp->poll_timeout);
141 	else
142 		wait = msecs_to_jiffies(wait_ms);
143 
144 	mod_timer(&musb->dev_timer, jiffies + wait);
145 }
146 
147 /*
148  * If no vbus irq from the PMIC is configured, we need to poll VBUS status.
149  */
150 static void dsps_mod_timer_optional(struct dsps_glue *glue)
151 {
152 	if (glue->vbus_irq)
153 		return;
154 
155 	dsps_mod_timer(glue, -1);
156 }
157 
158 /* USBSS  / USB AM335x */
159 #define USBSS_IRQ_STATUS	0x28
160 #define USBSS_IRQ_ENABLER	0x2c
161 #define USBSS_IRQ_CLEARR	0x30
162 
163 #define USBSS_IRQ_PD_COMP	(1 << 2)
164 
165 /**
166  * dsps_musb_enable - enable interrupts
167  */
168 static void dsps_musb_enable(struct musb *musb)
169 {
170 	struct device *dev = musb->controller;
171 	struct platform_device *pdev = to_platform_device(dev->parent);
172 	struct dsps_glue *glue = platform_get_drvdata(pdev);
173 	const struct dsps_musb_wrapper *wrp = glue->wrp;
174 	void __iomem *reg_base = musb->ctrl_base;
175 	u32 epmask, coremask;
176 
177 	/* Workaround: setup IRQs through both register sets. */
178 	epmask = ((musb->epmask & wrp->txep_mask) << wrp->txep_shift) |
179 	       ((musb->epmask & wrp->rxep_mask) << wrp->rxep_shift);
180 	coremask = (wrp->usb_bitmap & ~MUSB_INTR_SOF);
181 
182 	musb_writel(reg_base, wrp->epintr_set, epmask);
183 	musb_writel(reg_base, wrp->coreintr_set, coremask);
184 	/* start polling for ID change in dual-role idle mode */
185 	if (musb->xceiv->otg->state == OTG_STATE_B_IDLE &&
186 			musb->port_mode == MUSB_PORT_MODE_DUAL_ROLE)
187 		dsps_mod_timer(glue, -1);
188 }
189 
190 /**
191  * dsps_musb_disable - disable HDRC and flush interrupts
192  */
193 static void dsps_musb_disable(struct musb *musb)
194 {
195 	struct device *dev = musb->controller;
196 	struct platform_device *pdev = to_platform_device(dev->parent);
197 	struct dsps_glue *glue = platform_get_drvdata(pdev);
198 	const struct dsps_musb_wrapper *wrp = glue->wrp;
199 	void __iomem *reg_base = musb->ctrl_base;
200 
201 	musb_writel(reg_base, wrp->coreintr_clear, wrp->usb_bitmap);
202 	musb_writel(reg_base, wrp->epintr_clear,
203 			 wrp->txep_bitmap | wrp->rxep_bitmap);
204 	del_timer_sync(&musb->dev_timer);
205 }
206 
207 /* Caller must take musb->lock */
208 static int dsps_check_status(struct musb *musb, void *unused)
209 {
210 	void __iomem *mregs = musb->mregs;
211 	struct device *dev = musb->controller;
212 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
213 	const struct dsps_musb_wrapper *wrp = glue->wrp;
214 	u8 devctl;
215 	int skip_session = 0;
216 
217 	if (glue->vbus_irq)
218 		del_timer(&musb->dev_timer);
219 
220 	/*
221 	 * We poll because DSPS IP's won't expose several OTG-critical
222 	 * status change events (from the transceiver) otherwise.
223 	 */
224 	devctl = musb_readb(mregs, MUSB_DEVCTL);
225 	dev_dbg(musb->controller, "Poll devctl %02x (%s)\n", devctl,
226 				usb_otg_state_string(musb->xceiv->otg->state));
227 
228 	switch (musb->xceiv->otg->state) {
229 	case OTG_STATE_A_WAIT_VRISE:
230 		dsps_mod_timer_optional(glue);
231 		break;
232 	case OTG_STATE_A_WAIT_BCON:
233 		/* keep VBUS on for host-only mode */
234 		if (musb->port_mode == MUSB_PORT_MODE_HOST) {
235 			dsps_mod_timer_optional(glue);
236 			break;
237 		}
238 		musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
239 		skip_session = 1;
240 		/* fall */
241 
242 	case OTG_STATE_A_IDLE:
243 	case OTG_STATE_B_IDLE:
244 		if (!glue->vbus_irq) {
245 			if (devctl & MUSB_DEVCTL_BDEVICE) {
246 				musb->xceiv->otg->state = OTG_STATE_B_IDLE;
247 				MUSB_DEV_MODE(musb);
248 			} else {
249 				musb->xceiv->otg->state = OTG_STATE_A_IDLE;
250 				MUSB_HST_MODE(musb);
251 			}
252 			if (!(devctl & MUSB_DEVCTL_SESSION) && !skip_session)
253 				musb_writeb(mregs, MUSB_DEVCTL,
254 					    MUSB_DEVCTL_SESSION);
255 		}
256 		dsps_mod_timer_optional(glue);
257 		break;
258 	case OTG_STATE_A_WAIT_VFALL:
259 		musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
260 		musb_writel(musb->ctrl_base, wrp->coreintr_set,
261 			    MUSB_INTR_VBUSERROR << wrp->usb_shift);
262 		break;
263 	default:
264 		break;
265 	}
266 
267 	return 0;
268 }
269 
270 static void otg_timer(struct timer_list *t)
271 {
272 	struct musb *musb = from_timer(musb, t, dev_timer);
273 	struct device *dev = musb->controller;
274 	unsigned long flags;
275 	int err;
276 
277 	err = pm_runtime_get(dev);
278 	if ((err != -EINPROGRESS) && err < 0) {
279 		dev_err(dev, "Poll could not pm_runtime_get: %i\n", err);
280 		pm_runtime_put_noidle(dev);
281 
282 		return;
283 	}
284 
285 	spin_lock_irqsave(&musb->lock, flags);
286 	err = musb_queue_resume_work(musb, dsps_check_status, NULL);
287 	if (err < 0)
288 		dev_err(dev, "%s resume work: %i\n", __func__, err);
289 	spin_unlock_irqrestore(&musb->lock, flags);
290 	pm_runtime_mark_last_busy(dev);
291 	pm_runtime_put_autosuspend(dev);
292 }
293 
294 static void dsps_musb_clear_ep_rxintr(struct musb *musb, int epnum)
295 {
296 	u32 epintr;
297 	struct dsps_glue *glue = dev_get_drvdata(musb->controller->parent);
298 	const struct dsps_musb_wrapper *wrp = glue->wrp;
299 
300 	/* musb->lock might already been held */
301 	epintr = (1 << epnum) << wrp->rxep_shift;
302 	musb_writel(musb->ctrl_base, wrp->epintr_status, epintr);
303 }
304 
305 static irqreturn_t dsps_interrupt(int irq, void *hci)
306 {
307 	struct musb  *musb = hci;
308 	void __iomem *reg_base = musb->ctrl_base;
309 	struct device *dev = musb->controller;
310 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
311 	const struct dsps_musb_wrapper *wrp = glue->wrp;
312 	unsigned long flags;
313 	irqreturn_t ret = IRQ_NONE;
314 	u32 epintr, usbintr;
315 
316 	spin_lock_irqsave(&musb->lock, flags);
317 
318 	/* Get endpoint interrupts */
319 	epintr = musb_readl(reg_base, wrp->epintr_status);
320 	musb->int_rx = (epintr & wrp->rxep_bitmap) >> wrp->rxep_shift;
321 	musb->int_tx = (epintr & wrp->txep_bitmap) >> wrp->txep_shift;
322 
323 	if (epintr)
324 		musb_writel(reg_base, wrp->epintr_status, epintr);
325 
326 	/* Get usb core interrupts */
327 	usbintr = musb_readl(reg_base, wrp->coreintr_status);
328 	if (!usbintr && !epintr)
329 		goto out;
330 
331 	musb->int_usb =	(usbintr & wrp->usb_bitmap) >> wrp->usb_shift;
332 	if (usbintr)
333 		musb_writel(reg_base, wrp->coreintr_status, usbintr);
334 
335 	dev_dbg(musb->controller, "usbintr (%x) epintr(%x)\n",
336 			usbintr, epintr);
337 
338 	if (usbintr & ((1 << wrp->drvvbus) << wrp->usb_shift)) {
339 		int drvvbus = musb_readl(reg_base, wrp->status);
340 		void __iomem *mregs = musb->mregs;
341 		u8 devctl = musb_readb(mregs, MUSB_DEVCTL);
342 		int err;
343 
344 		err = musb->int_usb & MUSB_INTR_VBUSERROR;
345 		if (err) {
346 			/*
347 			 * The Mentor core doesn't debounce VBUS as needed
348 			 * to cope with device connect current spikes. This
349 			 * means it's not uncommon for bus-powered devices
350 			 * to get VBUS errors during enumeration.
351 			 *
352 			 * This is a workaround, but newer RTL from Mentor
353 			 * seems to allow a better one: "re"-starting sessions
354 			 * without waiting for VBUS to stop registering in
355 			 * devctl.
356 			 */
357 			musb->int_usb &= ~MUSB_INTR_VBUSERROR;
358 			musb->xceiv->otg->state = OTG_STATE_A_WAIT_VFALL;
359 			dsps_mod_timer_optional(glue);
360 			WARNING("VBUS error workaround (delay coming)\n");
361 		} else if (drvvbus) {
362 			MUSB_HST_MODE(musb);
363 			musb->xceiv->otg->default_a = 1;
364 			musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
365 			dsps_mod_timer_optional(glue);
366 		} else {
367 			musb->is_active = 0;
368 			MUSB_DEV_MODE(musb);
369 			musb->xceiv->otg->default_a = 0;
370 			musb->xceiv->otg->state = OTG_STATE_B_IDLE;
371 		}
372 
373 		/* NOTE: this must complete power-on within 100 ms. */
374 		dev_dbg(musb->controller, "VBUS %s (%s)%s, devctl %02x\n",
375 				drvvbus ? "on" : "off",
376 				usb_otg_state_string(musb->xceiv->otg->state),
377 				err ? " ERROR" : "",
378 				devctl);
379 		ret = IRQ_HANDLED;
380 	}
381 
382 	if (musb->int_tx || musb->int_rx || musb->int_usb)
383 		ret |= musb_interrupt(musb);
384 
385 	/* Poll for ID change and connect */
386 	switch (musb->xceiv->otg->state) {
387 	case OTG_STATE_B_IDLE:
388 	case OTG_STATE_A_WAIT_BCON:
389 		dsps_mod_timer_optional(glue);
390 		break;
391 	default:
392 		break;
393 	}
394 
395 out:
396 	spin_unlock_irqrestore(&musb->lock, flags);
397 
398 	return ret;
399 }
400 
401 static int dsps_musb_dbg_init(struct musb *musb, struct dsps_glue *glue)
402 {
403 	struct dentry *root;
404 	struct dentry *file;
405 	char buf[128];
406 
407 	sprintf(buf, "%s.dsps", dev_name(musb->controller));
408 	root = debugfs_create_dir(buf, NULL);
409 	if (!root)
410 		return -ENOMEM;
411 	glue->dbgfs_root = root;
412 
413 	glue->regset.regs = dsps_musb_regs;
414 	glue->regset.nregs = ARRAY_SIZE(dsps_musb_regs);
415 	glue->regset.base = musb->ctrl_base;
416 
417 	file = debugfs_create_regset32("regdump", S_IRUGO, root, &glue->regset);
418 	if (!file) {
419 		debugfs_remove_recursive(root);
420 		return -ENOMEM;
421 	}
422 	return 0;
423 }
424 
425 static int dsps_musb_init(struct musb *musb)
426 {
427 	struct device *dev = musb->controller;
428 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
429 	struct platform_device *parent = to_platform_device(dev->parent);
430 	const struct dsps_musb_wrapper *wrp = glue->wrp;
431 	void __iomem *reg_base;
432 	struct resource *r;
433 	u32 rev, val;
434 	int ret;
435 
436 	r = platform_get_resource_byname(parent, IORESOURCE_MEM, "control");
437 	reg_base = devm_ioremap_resource(dev, r);
438 	if (IS_ERR(reg_base))
439 		return PTR_ERR(reg_base);
440 	musb->ctrl_base = reg_base;
441 
442 	/* NOP driver needs change if supporting dual instance */
443 	musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent, "phys", 0);
444 	if (IS_ERR(musb->xceiv))
445 		return PTR_ERR(musb->xceiv);
446 
447 	musb->phy = devm_phy_get(dev->parent, "usb2-phy");
448 
449 	/* Returns zero if e.g. not clocked */
450 	rev = musb_readl(reg_base, wrp->revision);
451 	if (!rev)
452 		return -ENODEV;
453 
454 	if (IS_ERR(musb->phy))  {
455 		musb->phy = NULL;
456 	} else {
457 		ret = phy_init(musb->phy);
458 		if (ret < 0)
459 			return ret;
460 		ret = phy_power_on(musb->phy);
461 		if (ret) {
462 			phy_exit(musb->phy);
463 			return ret;
464 		}
465 	}
466 
467 	timer_setup(&musb->dev_timer, otg_timer, 0);
468 
469 	/* Reset the musb */
470 	musb_writel(reg_base, wrp->control, (1 << wrp->reset));
471 
472 	musb->isr = dsps_interrupt;
473 
474 	/* reset the otgdisable bit, needed for host mode to work */
475 	val = musb_readl(reg_base, wrp->phy_utmi);
476 	val &= ~(1 << wrp->otg_disable);
477 	musb_writel(musb->ctrl_base, wrp->phy_utmi, val);
478 
479 	/*
480 	 *  Check whether the dsps version has babble control enabled.
481 	 * In latest silicon revision the babble control logic is enabled.
482 	 * If MUSB_BABBLE_CTL returns 0x4 then we have the babble control
483 	 * logic enabled.
484 	 */
485 	val = musb_readb(musb->mregs, MUSB_BABBLE_CTL);
486 	if (val & MUSB_BABBLE_RCV_DISABLE) {
487 		glue->sw_babble_enabled = true;
488 		val |= MUSB_BABBLE_SW_SESSION_CTRL;
489 		musb_writeb(musb->mregs, MUSB_BABBLE_CTL, val);
490 	}
491 
492 	dsps_mod_timer(glue, -1);
493 
494 	return dsps_musb_dbg_init(musb, glue);
495 }
496 
497 static int dsps_musb_exit(struct musb *musb)
498 {
499 	struct device *dev = musb->controller;
500 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
501 
502 	del_timer_sync(&musb->dev_timer);
503 	phy_power_off(musb->phy);
504 	phy_exit(musb->phy);
505 	debugfs_remove_recursive(glue->dbgfs_root);
506 
507 	return 0;
508 }
509 
510 static int dsps_musb_set_mode(struct musb *musb, u8 mode)
511 {
512 	struct device *dev = musb->controller;
513 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
514 	const struct dsps_musb_wrapper *wrp = glue->wrp;
515 	void __iomem *ctrl_base = musb->ctrl_base;
516 	u32 reg;
517 
518 	reg = musb_readl(ctrl_base, wrp->mode);
519 
520 	switch (mode) {
521 	case MUSB_HOST:
522 		reg &= ~(1 << wrp->iddig);
523 
524 		/*
525 		 * if we're setting mode to host-only or device-only, we're
526 		 * going to ignore whatever the PHY sends us and just force
527 		 * ID pin status by SW
528 		 */
529 		reg |= (1 << wrp->iddig_mux);
530 
531 		musb_writel(ctrl_base, wrp->mode, reg);
532 		musb_writel(ctrl_base, wrp->phy_utmi, 0x02);
533 		break;
534 	case MUSB_PERIPHERAL:
535 		reg |= (1 << wrp->iddig);
536 
537 		/*
538 		 * if we're setting mode to host-only or device-only, we're
539 		 * going to ignore whatever the PHY sends us and just force
540 		 * ID pin status by SW
541 		 */
542 		reg |= (1 << wrp->iddig_mux);
543 
544 		musb_writel(ctrl_base, wrp->mode, reg);
545 		break;
546 	case MUSB_OTG:
547 		musb_writel(ctrl_base, wrp->phy_utmi, 0x02);
548 		break;
549 	default:
550 		dev_err(glue->dev, "unsupported mode %d\n", mode);
551 		return -EINVAL;
552 	}
553 
554 	return 0;
555 }
556 
557 static bool dsps_sw_babble_control(struct musb *musb)
558 {
559 	u8 babble_ctl;
560 	bool session_restart =  false;
561 
562 	babble_ctl = musb_readb(musb->mregs, MUSB_BABBLE_CTL);
563 	dev_dbg(musb->controller, "babble: MUSB_BABBLE_CTL value %x\n",
564 		babble_ctl);
565 	/*
566 	 * check line monitor flag to check whether babble is
567 	 * due to noise
568 	 */
569 	dev_dbg(musb->controller, "STUCK_J is %s\n",
570 		babble_ctl & MUSB_BABBLE_STUCK_J ? "set" : "reset");
571 
572 	if (babble_ctl & MUSB_BABBLE_STUCK_J) {
573 		int timeout = 10;
574 
575 		/*
576 		 * babble is due to noise, then set transmit idle (d7 bit)
577 		 * to resume normal operation
578 		 */
579 		babble_ctl = musb_readb(musb->mregs, MUSB_BABBLE_CTL);
580 		babble_ctl |= MUSB_BABBLE_FORCE_TXIDLE;
581 		musb_writeb(musb->mregs, MUSB_BABBLE_CTL, babble_ctl);
582 
583 		/* wait till line monitor flag cleared */
584 		dev_dbg(musb->controller, "Set TXIDLE, wait J to clear\n");
585 		do {
586 			babble_ctl = musb_readb(musb->mregs, MUSB_BABBLE_CTL);
587 			udelay(1);
588 		} while ((babble_ctl & MUSB_BABBLE_STUCK_J) && timeout--);
589 
590 		/* check whether stuck_at_j bit cleared */
591 		if (babble_ctl & MUSB_BABBLE_STUCK_J) {
592 			/*
593 			 * real babble condition has occurred
594 			 * restart the controller to start the
595 			 * session again
596 			 */
597 			dev_dbg(musb->controller, "J not cleared, misc (%x)\n",
598 				babble_ctl);
599 			session_restart = true;
600 		}
601 	} else {
602 		session_restart = true;
603 	}
604 
605 	return session_restart;
606 }
607 
608 static int dsps_musb_recover(struct musb *musb)
609 {
610 	struct device *dev = musb->controller;
611 	struct dsps_glue *glue = dev_get_drvdata(dev->parent);
612 	int session_restart = 0;
613 
614 	if (glue->sw_babble_enabled)
615 		session_restart = dsps_sw_babble_control(musb);
616 	else
617 		session_restart = 1;
618 
619 	return session_restart ? 0 : -EPIPE;
620 }
621 
622 /* Similar to am35x, dm81xx support only 32-bit read operation */
623 static void dsps_read_fifo32(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
624 {
625 	void __iomem *fifo = hw_ep->fifo;
626 
627 	if (len >= 4) {
628 		ioread32_rep(fifo, dst, len >> 2);
629 		dst += len & ~0x03;
630 		len &= 0x03;
631 	}
632 
633 	/* Read any remaining 1 to 3 bytes */
634 	if (len > 0) {
635 		u32 val = musb_readl(fifo, 0);
636 		memcpy(dst, &val, len);
637 	}
638 }
639 
640 #ifdef CONFIG_USB_TI_CPPI41_DMA
641 static void dsps_dma_controller_callback(struct dma_controller *c)
642 {
643 	struct musb *musb = c->musb;
644 	struct dsps_glue *glue = dev_get_drvdata(musb->controller->parent);
645 	void __iomem *usbss_base = glue->usbss_base;
646 	u32 status;
647 
648 	status = musb_readl(usbss_base, USBSS_IRQ_STATUS);
649 	if (status & USBSS_IRQ_PD_COMP)
650 		musb_writel(usbss_base, USBSS_IRQ_STATUS, USBSS_IRQ_PD_COMP);
651 }
652 
653 static struct dma_controller *
654 dsps_dma_controller_create(struct musb *musb, void __iomem *base)
655 {
656 	struct dma_controller *controller;
657 	struct dsps_glue *glue = dev_get_drvdata(musb->controller->parent);
658 	void __iomem *usbss_base = glue->usbss_base;
659 
660 	controller = cppi41_dma_controller_create(musb, base);
661 	if (IS_ERR_OR_NULL(controller))
662 		return controller;
663 
664 	musb_writel(usbss_base, USBSS_IRQ_ENABLER, USBSS_IRQ_PD_COMP);
665 	controller->dma_callback = dsps_dma_controller_callback;
666 
667 	return controller;
668 }
669 
670 static void dsps_dma_controller_destroy(struct dma_controller *c)
671 {
672 	struct musb *musb = c->musb;
673 	struct dsps_glue *glue = dev_get_drvdata(musb->controller->parent);
674 	void __iomem *usbss_base = glue->usbss_base;
675 
676 	musb_writel(usbss_base, USBSS_IRQ_CLEARR, USBSS_IRQ_PD_COMP);
677 	cppi41_dma_controller_destroy(c);
678 }
679 
680 #ifdef CONFIG_PM_SLEEP
681 static void dsps_dma_controller_suspend(struct dsps_glue *glue)
682 {
683 	void __iomem *usbss_base = glue->usbss_base;
684 
685 	musb_writel(usbss_base, USBSS_IRQ_CLEARR, USBSS_IRQ_PD_COMP);
686 }
687 
688 static void dsps_dma_controller_resume(struct dsps_glue *glue)
689 {
690 	void __iomem *usbss_base = glue->usbss_base;
691 
692 	musb_writel(usbss_base, USBSS_IRQ_ENABLER, USBSS_IRQ_PD_COMP);
693 }
694 #endif
695 #else /* CONFIG_USB_TI_CPPI41_DMA */
696 #ifdef CONFIG_PM_SLEEP
697 static void dsps_dma_controller_suspend(struct dsps_glue *glue) {}
698 static void dsps_dma_controller_resume(struct dsps_glue *glue) {}
699 #endif
700 #endif /* CONFIG_USB_TI_CPPI41_DMA */
701 
702 static struct musb_platform_ops dsps_ops = {
703 	.quirks		= MUSB_DMA_CPPI41 | MUSB_INDEXED_EP,
704 	.init		= dsps_musb_init,
705 	.exit		= dsps_musb_exit,
706 
707 #ifdef CONFIG_USB_TI_CPPI41_DMA
708 	.dma_init	= dsps_dma_controller_create,
709 	.dma_exit	= dsps_dma_controller_destroy,
710 #endif
711 	.enable		= dsps_musb_enable,
712 	.disable	= dsps_musb_disable,
713 
714 	.set_mode	= dsps_musb_set_mode,
715 	.recover	= dsps_musb_recover,
716 	.clear_ep_rxintr = dsps_musb_clear_ep_rxintr,
717 };
718 
719 static u64 musb_dmamask = DMA_BIT_MASK(32);
720 
721 static int get_int_prop(struct device_node *dn, const char *s)
722 {
723 	int ret;
724 	u32 val;
725 
726 	ret = of_property_read_u32(dn, s, &val);
727 	if (ret)
728 		return 0;
729 	return val;
730 }
731 
732 static int get_musb_port_mode(struct device *dev)
733 {
734 	enum usb_dr_mode mode;
735 
736 	mode = usb_get_dr_mode(dev);
737 	switch (mode) {
738 	case USB_DR_MODE_HOST:
739 		return MUSB_PORT_MODE_HOST;
740 
741 	case USB_DR_MODE_PERIPHERAL:
742 		return MUSB_PORT_MODE_GADGET;
743 
744 	case USB_DR_MODE_UNKNOWN:
745 	case USB_DR_MODE_OTG:
746 	default:
747 		return MUSB_PORT_MODE_DUAL_ROLE;
748 	}
749 }
750 
751 static int dsps_create_musb_pdev(struct dsps_glue *glue,
752 		struct platform_device *parent)
753 {
754 	struct musb_hdrc_platform_data pdata;
755 	struct resource	resources[2];
756 	struct resource	*res;
757 	struct device *dev = &parent->dev;
758 	struct musb_hdrc_config	*config;
759 	struct platform_device *musb;
760 	struct device_node *dn = parent->dev.of_node;
761 	int ret, val;
762 
763 	memset(resources, 0, sizeof(resources));
764 	res = platform_get_resource_byname(parent, IORESOURCE_MEM, "mc");
765 	if (!res) {
766 		dev_err(dev, "failed to get memory.\n");
767 		return -EINVAL;
768 	}
769 	resources[0] = *res;
770 
771 	res = platform_get_resource_byname(parent, IORESOURCE_IRQ, "mc");
772 	if (!res) {
773 		dev_err(dev, "failed to get irq.\n");
774 		return -EINVAL;
775 	}
776 	resources[1] = *res;
777 
778 	/* allocate the child platform device */
779 	musb = platform_device_alloc("musb-hdrc",
780 			(resources[0].start & 0xFFF) == 0x400 ? 0 : 1);
781 	if (!musb) {
782 		dev_err(dev, "failed to allocate musb device\n");
783 		return -ENOMEM;
784 	}
785 
786 	musb->dev.parent		= dev;
787 	musb->dev.dma_mask		= &musb_dmamask;
788 	musb->dev.coherent_dma_mask	= musb_dmamask;
789 
790 	glue->musb = musb;
791 
792 	ret = platform_device_add_resources(musb, resources,
793 			ARRAY_SIZE(resources));
794 	if (ret) {
795 		dev_err(dev, "failed to add resources\n");
796 		goto err;
797 	}
798 
799 	config = devm_kzalloc(&parent->dev, sizeof(*config), GFP_KERNEL);
800 	if (!config) {
801 		ret = -ENOMEM;
802 		goto err;
803 	}
804 	pdata.config = config;
805 	pdata.platform_ops = &dsps_ops;
806 
807 	config->num_eps = get_int_prop(dn, "mentor,num-eps");
808 	config->ram_bits = get_int_prop(dn, "mentor,ram-bits");
809 	config->host_port_deassert_reset_at_resume = 1;
810 	pdata.mode = get_musb_port_mode(dev);
811 	/* DT keeps this entry in mA, musb expects it as per USB spec */
812 	pdata.power = get_int_prop(dn, "mentor,power") / 2;
813 
814 	ret = of_property_read_u32(dn, "mentor,multipoint", &val);
815 	if (!ret && val)
816 		config->multipoint = true;
817 
818 	config->maximum_speed = usb_get_maximum_speed(&parent->dev);
819 	switch (config->maximum_speed) {
820 	case USB_SPEED_LOW:
821 	case USB_SPEED_FULL:
822 		break;
823 	case USB_SPEED_SUPER:
824 		dev_warn(dev, "ignore incorrect maximum_speed "
825 				"(super-speed) setting in dts");
826 		/* fall through */
827 	default:
828 		config->maximum_speed = USB_SPEED_HIGH;
829 	}
830 
831 	ret = platform_device_add_data(musb, &pdata, sizeof(pdata));
832 	if (ret) {
833 		dev_err(dev, "failed to add platform_data\n");
834 		goto err;
835 	}
836 
837 	ret = platform_device_add(musb);
838 	if (ret) {
839 		dev_err(dev, "failed to register musb device\n");
840 		goto err;
841 	}
842 	return 0;
843 
844 err:
845 	platform_device_put(musb);
846 	return ret;
847 }
848 
849 static irqreturn_t dsps_vbus_threaded_irq(int irq, void *priv)
850 {
851 	struct dsps_glue *glue = priv;
852 	struct musb *musb = platform_get_drvdata(glue->musb);
853 
854 	if (!musb)
855 		return IRQ_NONE;
856 
857 	dev_dbg(glue->dev, "VBUS interrupt\n");
858 	dsps_mod_timer(glue, 0);
859 
860 	return IRQ_HANDLED;
861 }
862 
863 static int dsps_setup_optional_vbus_irq(struct platform_device *pdev,
864 					struct dsps_glue *glue)
865 {
866 	int error;
867 
868 	glue->vbus_irq = platform_get_irq_byname(pdev, "vbus");
869 	if (glue->vbus_irq == -EPROBE_DEFER)
870 		return -EPROBE_DEFER;
871 
872 	if (glue->vbus_irq <= 0) {
873 		glue->vbus_irq = 0;
874 		return 0;
875 	}
876 
877 	error = devm_request_threaded_irq(glue->dev, glue->vbus_irq,
878 					  NULL, dsps_vbus_threaded_irq,
879 					  IRQF_ONESHOT,
880 					  "vbus", glue);
881 	if (error) {
882 		glue->vbus_irq = 0;
883 		return error;
884 	}
885 	dev_dbg(glue->dev, "VBUS irq %i configured\n", glue->vbus_irq);
886 
887 	return 0;
888 }
889 
890 static int dsps_probe(struct platform_device *pdev)
891 {
892 	const struct of_device_id *match;
893 	const struct dsps_musb_wrapper *wrp;
894 	struct dsps_glue *glue;
895 	int ret;
896 
897 	if (!strcmp(pdev->name, "musb-hdrc"))
898 		return -ENODEV;
899 
900 	match = of_match_node(musb_dsps_of_match, pdev->dev.of_node);
901 	if (!match) {
902 		dev_err(&pdev->dev, "fail to get matching of_match struct\n");
903 		return -EINVAL;
904 	}
905 	wrp = match->data;
906 
907 	if (of_device_is_compatible(pdev->dev.of_node, "ti,musb-dm816"))
908 		dsps_ops.read_fifo = dsps_read_fifo32;
909 
910 	/* allocate glue */
911 	glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
912 	if (!glue)
913 		return -ENOMEM;
914 
915 	glue->dev = &pdev->dev;
916 	glue->wrp = wrp;
917 	glue->usbss_base = of_iomap(pdev->dev.parent->of_node, 0);
918 	if (!glue->usbss_base)
919 		return -ENXIO;
920 
921 	if (usb_get_dr_mode(&pdev->dev) == USB_DR_MODE_PERIPHERAL) {
922 		ret = dsps_setup_optional_vbus_irq(pdev, glue);
923 		if (ret)
924 			goto err_iounmap;
925 	}
926 
927 	platform_set_drvdata(pdev, glue);
928 	pm_runtime_enable(&pdev->dev);
929 	ret = dsps_create_musb_pdev(glue, pdev);
930 	if (ret)
931 		goto err;
932 
933 	return 0;
934 
935 err:
936 	pm_runtime_disable(&pdev->dev);
937 err_iounmap:
938 	iounmap(glue->usbss_base);
939 	return ret;
940 }
941 
942 static int dsps_remove(struct platform_device *pdev)
943 {
944 	struct dsps_glue *glue = platform_get_drvdata(pdev);
945 
946 	platform_device_unregister(glue->musb);
947 
948 	pm_runtime_disable(&pdev->dev);
949 	iounmap(glue->usbss_base);
950 
951 	return 0;
952 }
953 
954 static const struct dsps_musb_wrapper am33xx_driver_data = {
955 	.revision		= 0x00,
956 	.control		= 0x14,
957 	.status			= 0x18,
958 	.epintr_set		= 0x38,
959 	.epintr_clear		= 0x40,
960 	.epintr_status		= 0x30,
961 	.coreintr_set		= 0x3c,
962 	.coreintr_clear		= 0x44,
963 	.coreintr_status	= 0x34,
964 	.phy_utmi		= 0xe0,
965 	.mode			= 0xe8,
966 	.tx_mode		= 0x70,
967 	.rx_mode		= 0x74,
968 	.reset			= 0,
969 	.otg_disable		= 21,
970 	.iddig			= 8,
971 	.iddig_mux		= 7,
972 	.usb_shift		= 0,
973 	.usb_mask		= 0x1ff,
974 	.usb_bitmap		= (0x1ff << 0),
975 	.drvvbus		= 8,
976 	.txep_shift		= 0,
977 	.txep_mask		= 0xffff,
978 	.txep_bitmap		= (0xffff << 0),
979 	.rxep_shift		= 16,
980 	.rxep_mask		= 0xfffe,
981 	.rxep_bitmap		= (0xfffe << 16),
982 	.poll_timeout		= 2000, /* ms */
983 };
984 
985 static const struct of_device_id musb_dsps_of_match[] = {
986 	{ .compatible = "ti,musb-am33xx",
987 		.data = &am33xx_driver_data, },
988 	{ .compatible = "ti,musb-dm816",
989 		.data = &am33xx_driver_data, },
990 	{  },
991 };
992 MODULE_DEVICE_TABLE(of, musb_dsps_of_match);
993 
994 #ifdef CONFIG_PM_SLEEP
995 static int dsps_suspend(struct device *dev)
996 {
997 	struct dsps_glue *glue = dev_get_drvdata(dev);
998 	const struct dsps_musb_wrapper *wrp = glue->wrp;
999 	struct musb *musb = platform_get_drvdata(glue->musb);
1000 	void __iomem *mbase;
1001 	int ret;
1002 
1003 	if (!musb)
1004 		/* This can happen if the musb device is in -EPROBE_DEFER */
1005 		return 0;
1006 
1007 	ret = pm_runtime_get_sync(dev);
1008 	if (ret < 0) {
1009 		pm_runtime_put_noidle(dev);
1010 		return ret;
1011 	}
1012 
1013 	del_timer_sync(&musb->dev_timer);
1014 
1015 	mbase = musb->ctrl_base;
1016 	glue->context.control = musb_readl(mbase, wrp->control);
1017 	glue->context.epintr = musb_readl(mbase, wrp->epintr_set);
1018 	glue->context.coreintr = musb_readl(mbase, wrp->coreintr_set);
1019 	glue->context.phy_utmi = musb_readl(mbase, wrp->phy_utmi);
1020 	glue->context.mode = musb_readl(mbase, wrp->mode);
1021 	glue->context.tx_mode = musb_readl(mbase, wrp->tx_mode);
1022 	glue->context.rx_mode = musb_readl(mbase, wrp->rx_mode);
1023 
1024 	dsps_dma_controller_suspend(glue);
1025 
1026 	return 0;
1027 }
1028 
1029 static int dsps_resume(struct device *dev)
1030 {
1031 	struct dsps_glue *glue = dev_get_drvdata(dev);
1032 	const struct dsps_musb_wrapper *wrp = glue->wrp;
1033 	struct musb *musb = platform_get_drvdata(glue->musb);
1034 	void __iomem *mbase;
1035 
1036 	if (!musb)
1037 		return 0;
1038 
1039 	dsps_dma_controller_resume(glue);
1040 
1041 	mbase = musb->ctrl_base;
1042 	musb_writel(mbase, wrp->control, glue->context.control);
1043 	musb_writel(mbase, wrp->epintr_set, glue->context.epintr);
1044 	musb_writel(mbase, wrp->coreintr_set, glue->context.coreintr);
1045 	musb_writel(mbase, wrp->phy_utmi, glue->context.phy_utmi);
1046 	musb_writel(mbase, wrp->mode, glue->context.mode);
1047 	musb_writel(mbase, wrp->tx_mode, glue->context.tx_mode);
1048 	musb_writel(mbase, wrp->rx_mode, glue->context.rx_mode);
1049 	if (musb->xceiv->otg->state == OTG_STATE_B_IDLE &&
1050 	    musb->port_mode == MUSB_PORT_MODE_DUAL_ROLE)
1051 		dsps_mod_timer(glue, -1);
1052 
1053 	pm_runtime_put(dev);
1054 
1055 	return 0;
1056 }
1057 #endif
1058 
1059 static SIMPLE_DEV_PM_OPS(dsps_pm_ops, dsps_suspend, dsps_resume);
1060 
1061 static struct platform_driver dsps_usbss_driver = {
1062 	.probe		= dsps_probe,
1063 	.remove         = dsps_remove,
1064 	.driver         = {
1065 		.name   = "musb-dsps",
1066 		.pm	= &dsps_pm_ops,
1067 		.of_match_table	= musb_dsps_of_match,
1068 	},
1069 };
1070 
1071 MODULE_DESCRIPTION("TI DSPS MUSB Glue Layer");
1072 MODULE_AUTHOR("Ravi B <ravibabu@ti.com>");
1073 MODULE_AUTHOR("Ajay Kumar Gupta <ajay.gupta@ti.com>");
1074 MODULE_LICENSE("GPL v2");
1075 
1076 module_platform_driver(dsps_usbss_driver);
1077