xref: /rk3399_rockchip-uboot/drivers/usb/dwc3/core.c (revision 4a2b8db466479ddec6ee85f9fe9d7f934016be9a)
1 /**
2  * core.c - DesignWare USB3 DRD Controller Core file
3  *
4  * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
5  *
6  * Authors: Felipe Balbi <balbi@ti.com>,
7  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8  *
9  * Taken from Linux Kernel v3.19-rc1 (drivers/usb/dwc3/core.c) and ported
10  * to uboot.
11  *
12  * commit cd72f890d2 : usb: dwc3: core: enable phy suspend quirk on non-FPGA
13  *
14  * SPDX-License-Identifier:     GPL-2.0
15  */
16 
17 #include <common.h>
18 #include <malloc.h>
19 #include <fdtdec.h>
20 #include <dwc3-uboot.h>
21 #include <asm/dma-mapping.h>
22 #include <linux/ioport.h>
23 #include <dm.h>
24 #include <generic-phy.h>
25 #include <linux/usb/ch9.h>
26 #include <linux/usb/gadget.h>
27 
28 #include "core.h"
29 #include "gadget.h"
30 #include "io.h"
31 
32 #include "linux-compat.h"
33 
34 DECLARE_GLOBAL_DATA_PTR;
35 
36 static LIST_HEAD(dwc3_list);
37 /* -------------------------------------------------------------------------- */
38 
39 static void dwc3_set_mode(struct dwc3 *dwc, u32 mode)
40 {
41 	u32 reg;
42 
43 	reg = dwc3_readl(dwc->regs, DWC3_GCTL);
44 	reg &= ~(DWC3_GCTL_PRTCAPDIR(DWC3_GCTL_PRTCAP_OTG));
45 	reg |= DWC3_GCTL_PRTCAPDIR(mode);
46 	dwc3_writel(dwc->regs, DWC3_GCTL, reg);
47 }
48 
49 /**
50  * dwc3_core_soft_reset - Issues core soft reset and PHY reset
51  * @dwc: pointer to our context structure
52  */
53 static int dwc3_core_soft_reset(struct dwc3 *dwc)
54 {
55 	u32		reg;
56 
57 	/* Before Resetting PHY, put Core in Reset */
58 	reg = dwc3_readl(dwc->regs, DWC3_GCTL);
59 	reg |= DWC3_GCTL_CORESOFTRESET;
60 	dwc3_writel(dwc->regs, DWC3_GCTL, reg);
61 
62 	/* Assert USB3 PHY reset */
63 	reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
64 	reg |= DWC3_GUSB3PIPECTL_PHYSOFTRST;
65 	dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
66 
67 	/* Assert USB2 PHY reset */
68 	reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
69 	reg |= DWC3_GUSB2PHYCFG_PHYSOFTRST;
70 	dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
71 
72 	mdelay(100);
73 
74 	/* Clear USB3 PHY reset */
75 	reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
76 	reg &= ~DWC3_GUSB3PIPECTL_PHYSOFTRST;
77 	dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
78 
79 	/* Clear USB2 PHY reset */
80 	reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
81 	reg &= ~DWC3_GUSB2PHYCFG_PHYSOFTRST;
82 	dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
83 
84 	mdelay(100);
85 
86 	/* After PHYs are stable we can take Core out of reset state */
87 	reg = dwc3_readl(dwc->regs, DWC3_GCTL);
88 	reg &= ~DWC3_GCTL_CORESOFTRESET;
89 	dwc3_writel(dwc->regs, DWC3_GCTL, reg);
90 
91 	return 0;
92 }
93 
94 /**
95  * dwc3_free_one_event_buffer - Frees one event buffer
96  * @dwc: Pointer to our controller context structure
97  * @evt: Pointer to event buffer to be freed
98  */
99 static void dwc3_free_one_event_buffer(struct dwc3 *dwc,
100 		struct dwc3_event_buffer *evt)
101 {
102 	dma_free_coherent(evt->buf);
103 }
104 
105 /**
106  * dwc3_alloc_one_event_buffer - Allocates one event buffer structure
107  * @dwc: Pointer to our controller context structure
108  * @length: size of the event buffer
109  *
110  * Returns a pointer to the allocated event buffer structure on success
111  * otherwise ERR_PTR(errno).
112  */
113 static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
114 		unsigned length)
115 {
116 	struct dwc3_event_buffer	*evt;
117 
118 	evt = devm_kzalloc((struct udevice *)dwc->dev, sizeof(*evt),
119 			   GFP_KERNEL);
120 	if (!evt)
121 		return ERR_PTR(-ENOMEM);
122 
123 	evt->dwc	= dwc;
124 	evt->length	= length;
125 	evt->buf	= dma_alloc_coherent(length,
126 					     (unsigned long *)&evt->dma);
127 	if (!evt->buf)
128 		return ERR_PTR(-ENOMEM);
129 
130 	dwc3_flush_cache((uintptr_t)evt->buf, evt->length);
131 
132 	return evt;
133 }
134 
135 /**
136  * dwc3_free_event_buffers - frees all allocated event buffers
137  * @dwc: Pointer to our controller context structure
138  */
139 static void dwc3_free_event_buffers(struct dwc3 *dwc)
140 {
141 	struct dwc3_event_buffer	*evt;
142 	int i;
143 
144 	for (i = 0; i < dwc->num_event_buffers; i++) {
145 		evt = dwc->ev_buffs[i];
146 		if (evt)
147 			dwc3_free_one_event_buffer(dwc, evt);
148 	}
149 }
150 
151 /**
152  * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
153  * @dwc: pointer to our controller context structure
154  * @length: size of event buffer
155  *
156  * Returns 0 on success otherwise negative errno. In the error case, dwc
157  * may contain some buffers allocated but not all which were requested.
158  */
159 static int dwc3_alloc_event_buffers(struct dwc3 *dwc, unsigned length)
160 {
161 	int			num;
162 	int			i;
163 
164 	num = DWC3_NUM_INT(dwc->hwparams.hwparams1);
165 	dwc->num_event_buffers = num;
166 
167 	dwc->ev_buffs = memalign(CONFIG_SYS_CACHELINE_SIZE,
168 				 sizeof(*dwc->ev_buffs) * num);
169 	if (!dwc->ev_buffs)
170 		return -ENOMEM;
171 
172 	for (i = 0; i < num; i++) {
173 		struct dwc3_event_buffer	*evt;
174 
175 		evt = dwc3_alloc_one_event_buffer(dwc, length);
176 		if (IS_ERR(evt)) {
177 			dev_err(dwc->dev, "can't allocate event buffer\n");
178 			return PTR_ERR(evt);
179 		}
180 		dwc->ev_buffs[i] = evt;
181 	}
182 
183 	return 0;
184 }
185 
186 /**
187  * dwc3_event_buffers_setup - setup our allocated event buffers
188  * @dwc: pointer to our controller context structure
189  *
190  * Returns 0 on success otherwise negative errno.
191  */
192 static int dwc3_event_buffers_setup(struct dwc3 *dwc)
193 {
194 	struct dwc3_event_buffer	*evt;
195 	int				n;
196 
197 	for (n = 0; n < dwc->num_event_buffers; n++) {
198 		evt = dwc->ev_buffs[n];
199 		dev_dbg(dwc->dev, "Event buf %p dma %08llx length %d\n",
200 				evt->buf, (unsigned long long) evt->dma,
201 				evt->length);
202 
203 		evt->lpos = 0;
204 
205 		dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(n),
206 				lower_32_bits(evt->dma));
207 		dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(n),
208 				upper_32_bits(evt->dma));
209 		dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(n),
210 				DWC3_GEVNTSIZ_SIZE(evt->length));
211 		dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(n), 0);
212 	}
213 
214 	return 0;
215 }
216 
217 static void dwc3_event_buffers_cleanup(struct dwc3 *dwc)
218 {
219 	struct dwc3_event_buffer	*evt;
220 	int				n;
221 
222 	for (n = 0; n < dwc->num_event_buffers; n++) {
223 		evt = dwc->ev_buffs[n];
224 
225 		evt->lpos = 0;
226 
227 		dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(n), 0);
228 		dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(n), 0);
229 		dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(n), DWC3_GEVNTSIZ_INTMASK
230 				| DWC3_GEVNTSIZ_SIZE(0));
231 		dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(n), 0);
232 	}
233 }
234 
235 static int dwc3_alloc_scratch_buffers(struct dwc3 *dwc)
236 {
237 	if (!dwc->has_hibernation)
238 		return 0;
239 
240 	if (!dwc->nr_scratch)
241 		return 0;
242 
243 	dwc->scratchbuf = kmalloc_array(dwc->nr_scratch,
244 			DWC3_SCRATCHBUF_SIZE, GFP_KERNEL);
245 	if (!dwc->scratchbuf)
246 		return -ENOMEM;
247 
248 	return 0;
249 }
250 
251 static int dwc3_setup_scratch_buffers(struct dwc3 *dwc)
252 {
253 	dma_addr_t scratch_addr;
254 	u32 param;
255 	int ret;
256 
257 	if (!dwc->has_hibernation)
258 		return 0;
259 
260 	if (!dwc->nr_scratch)
261 		return 0;
262 
263 	scratch_addr = dma_map_single(dwc->scratchbuf,
264 				      dwc->nr_scratch * DWC3_SCRATCHBUF_SIZE,
265 				      DMA_BIDIRECTIONAL);
266 	if (dma_mapping_error(dwc->dev, scratch_addr)) {
267 		dev_err(dwc->dev, "failed to map scratch buffer\n");
268 		ret = -EFAULT;
269 		goto err0;
270 	}
271 
272 	dwc->scratch_addr = scratch_addr;
273 
274 	param = lower_32_bits(scratch_addr);
275 
276 	ret = dwc3_send_gadget_generic_command(dwc,
277 			DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO, param);
278 	if (ret < 0)
279 		goto err1;
280 
281 	param = upper_32_bits(scratch_addr);
282 
283 	ret = dwc3_send_gadget_generic_command(dwc,
284 			DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI, param);
285 	if (ret < 0)
286 		goto err1;
287 
288 	return 0;
289 
290 err1:
291 	dma_unmap_single((void *)(uintptr_t)dwc->scratch_addr, dwc->nr_scratch *
292 			 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
293 
294 err0:
295 	return ret;
296 }
297 
298 static void dwc3_free_scratch_buffers(struct dwc3 *dwc)
299 {
300 	if (!dwc->has_hibernation)
301 		return;
302 
303 	if (!dwc->nr_scratch)
304 		return;
305 
306 	dma_unmap_single((void *)(uintptr_t)dwc->scratch_addr, dwc->nr_scratch *
307 			 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
308 	kfree(dwc->scratchbuf);
309 }
310 
311 static void dwc3_core_num_eps(struct dwc3 *dwc)
312 {
313 	struct dwc3_hwparams	*parms = &dwc->hwparams;
314 
315 	dwc->num_in_eps = DWC3_NUM_IN_EPS(parms);
316 	dwc->num_out_eps = DWC3_NUM_EPS(parms) - dwc->num_in_eps;
317 
318 	dev_vdbg(dwc->dev, "found %d IN and %d OUT endpoints\n",
319 			dwc->num_in_eps, dwc->num_out_eps);
320 }
321 
322 static void dwc3_cache_hwparams(struct dwc3 *dwc)
323 {
324 	struct dwc3_hwparams	*parms = &dwc->hwparams;
325 
326 	parms->hwparams0 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS0);
327 	parms->hwparams1 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS1);
328 	parms->hwparams2 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS2);
329 	parms->hwparams3 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS3);
330 	parms->hwparams4 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS4);
331 	parms->hwparams5 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS5);
332 	parms->hwparams6 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS6);
333 	parms->hwparams7 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS7);
334 	parms->hwparams8 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS8);
335 }
336 
337 static void dwc3_hsphy_mode_setup(struct dwc3 *dwc)
338 {
339 	enum usb_phy_interface hsphy_mode = dwc->hsphy_mode;
340 	u32 reg;
341 
342 	/* Set dwc3 usb2 phy config */
343 	reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
344 
345 	switch (hsphy_mode) {
346 	case USBPHY_INTERFACE_MODE_UTMI:
347 		reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
348 			DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
349 		reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_8_BIT) |
350 			DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_8_BIT);
351 		break;
352 	case USBPHY_INTERFACE_MODE_UTMIW:
353 		reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
354 			DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
355 		reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_16_BIT) |
356 			DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_16_BIT);
357 		break;
358 	default:
359 		break;
360 	}
361 
362 	dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
363 }
364 
365 /**
366  * dwc3_phy_setup - Configure USB PHY Interface of DWC3 Core
367  * @dwc: Pointer to our controller context structure
368  */
369 static void dwc3_phy_setup(struct dwc3 *dwc)
370 {
371 	u32 reg;
372 
373 	reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
374 
375 	/*
376 	 * Above 1.94a, it is recommended to set DWC3_GUSB3PIPECTL_SUSPHY
377 	 * to '0' during coreConsultant configuration. So default value
378 	 * will be '0' when the core is reset. Application needs to set it
379 	 * to '1' after the core initialization is completed.
380 	 */
381 	if (dwc->revision > DWC3_REVISION_194A)
382 		reg |= DWC3_GUSB3PIPECTL_SUSPHY;
383 
384 	if (dwc->u2ss_inp3_quirk)
385 		reg |= DWC3_GUSB3PIPECTL_U2SSINP3OK;
386 
387 	if (dwc->req_p1p2p3_quirk)
388 		reg |= DWC3_GUSB3PIPECTL_REQP1P2P3;
389 
390 	if (dwc->del_p1p2p3_quirk)
391 		reg |= DWC3_GUSB3PIPECTL_DEP1P2P3_EN;
392 
393 	if (dwc->del_phy_power_chg_quirk)
394 		reg |= DWC3_GUSB3PIPECTL_DEPOCHANGE;
395 
396 	if (dwc->lfps_filter_quirk)
397 		reg |= DWC3_GUSB3PIPECTL_LFPSFILT;
398 
399 	if (dwc->rx_detect_poll_quirk)
400 		reg |= DWC3_GUSB3PIPECTL_RX_DETOPOLL;
401 
402 	if (dwc->tx_de_emphasis_quirk)
403 		reg |= DWC3_GUSB3PIPECTL_TX_DEEPH(dwc->tx_de_emphasis);
404 
405 	if (dwc->dis_u3_susphy_quirk)
406 		reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
407 
408 	dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
409 
410 	dwc3_hsphy_mode_setup(dwc);
411 
412 	mdelay(100);
413 
414 	reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
415 
416 	/*
417 	 * Above 1.94a, it is recommended to set DWC3_GUSB2PHYCFG_SUSPHY to
418 	 * '0' during coreConsultant configuration. So default value will
419 	 * be '0' when the core is reset. Application needs to set it to
420 	 * '1' after the core initialization is completed.
421 	 */
422 	if (dwc->revision > DWC3_REVISION_194A)
423 		reg |= DWC3_GUSB2PHYCFG_SUSPHY;
424 
425 	if (dwc->dis_u2_susphy_quirk)
426 		reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
427 
428 	if (dwc->dis_enblslpm_quirk)
429 		reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
430 
431 	if (dwc->dis_u2_freeclk_exists_quirk)
432 		reg &= ~DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS;
433 
434 	if (dwc->usb2_phyif_utmi_width == 16) {
435 		reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
436 			DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
437 		reg |= DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_16_BIT);
438 		reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_16_BIT);
439 	}
440 	dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
441 
442 	mdelay(100);
443 }
444 
445 /**
446  * dwc3_core_init - Low-level initialization of DWC3 Core
447  * @dwc: Pointer to our controller context structure
448  *
449  * Returns 0 on success otherwise negative errno.
450  */
451 static int dwc3_core_init(struct dwc3 *dwc)
452 {
453 	unsigned long		timeout;
454 	u32			hwparams4 = dwc->hwparams.hwparams4;
455 	u32			reg;
456 	int			ret;
457 
458 	reg = dwc3_readl(dwc->regs, DWC3_GSNPSID);
459 	/* This should read as U3 followed by revision number */
460 	if ((reg & DWC3_GSNPSID_MASK) != 0x55330000) {
461 		dev_err(dwc->dev, "this is not a DesignWare USB3 DRD Core\n");
462 		ret = -ENODEV;
463 		goto err0;
464 	}
465 	dwc->revision = reg;
466 
467 	/* Handle USB2.0-only core configuration */
468 	if (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
469 			DWC3_GHWPARAMS3_SSPHY_IFC_DIS) {
470 		if (dwc->maximum_speed == USB_SPEED_SUPER)
471 			dwc->maximum_speed = USB_SPEED_HIGH;
472 	}
473 
474 	/* issue device SoftReset too */
475 	timeout = 5000;
476 	dwc3_writel(dwc->regs, DWC3_DCTL, DWC3_DCTL_CSFTRST);
477 	while (timeout--) {
478 		reg = dwc3_readl(dwc->regs, DWC3_DCTL);
479 		if (!(reg & DWC3_DCTL_CSFTRST))
480 			break;
481 	};
482 
483 	if (!timeout) {
484 		dev_err(dwc->dev, "Reset Timed Out\n");
485 		ret = -ETIMEDOUT;
486 		goto err0;
487 	}
488 
489 	ret = dwc3_core_soft_reset(dwc);
490 	if (ret)
491 		goto err0;
492 
493 	reg = dwc3_readl(dwc->regs, DWC3_GCTL);
494 	reg &= ~DWC3_GCTL_SCALEDOWN_MASK;
495 
496 	switch (DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1)) {
497 	case DWC3_GHWPARAMS1_EN_PWROPT_CLK:
498 		/**
499 		 * WORKAROUND: DWC3 revisions between 2.10a and 2.50a have an
500 		 * issue which would cause xHCI compliance tests to fail.
501 		 *
502 		 * Because of that we cannot enable clock gating on such
503 		 * configurations.
504 		 *
505 		 * Refers to:
506 		 *
507 		 * STAR#9000588375: Clock Gating, SOF Issues when ref_clk-Based
508 		 * SOF/ITP Mode Used
509 		 */
510 		if ((dwc->dr_mode == USB_DR_MODE_HOST ||
511 				dwc->dr_mode == USB_DR_MODE_OTG) &&
512 				(dwc->revision >= DWC3_REVISION_210A &&
513 				dwc->revision <= DWC3_REVISION_250A))
514 			reg |= DWC3_GCTL_DSBLCLKGTNG | DWC3_GCTL_SOFITPSYNC;
515 		else
516 			reg &= ~DWC3_GCTL_DSBLCLKGTNG;
517 		break;
518 	case DWC3_GHWPARAMS1_EN_PWROPT_HIB:
519 		/* enable hibernation here */
520 		dwc->nr_scratch = DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(hwparams4);
521 
522 		/*
523 		 * REVISIT Enabling this bit so that host-mode hibernation
524 		 * will work. Device-mode hibernation is not yet implemented.
525 		 */
526 		reg |= DWC3_GCTL_GBLHIBERNATIONEN;
527 		break;
528 	default:
529 		dev_dbg(dwc->dev, "No power optimization available\n");
530 	}
531 
532 	/* check if current dwc3 is on simulation board */
533 	if (dwc->hwparams.hwparams6 & DWC3_GHWPARAMS6_EN_FPGA) {
534 		dev_dbg(dwc->dev, "it is on FPGA board\n");
535 		dwc->is_fpga = true;
536 	}
537 
538 	if(dwc->disable_scramble_quirk && !dwc->is_fpga)
539 		WARN(true,
540 		     "disable_scramble cannot be used on non-FPGA builds\n");
541 
542 	if (dwc->disable_scramble_quirk && dwc->is_fpga)
543 		reg |= DWC3_GCTL_DISSCRAMBLE;
544 	else
545 		reg &= ~DWC3_GCTL_DISSCRAMBLE;
546 
547 	if (dwc->u2exit_lfps_quirk)
548 		reg |= DWC3_GCTL_U2EXIT_LFPS;
549 
550 	/*
551 	 * WORKAROUND: DWC3 revisions <1.90a have a bug
552 	 * where the device can fail to connect at SuperSpeed
553 	 * and falls back to high-speed mode which causes
554 	 * the device to enter a Connect/Disconnect loop
555 	 */
556 	if (dwc->revision < DWC3_REVISION_190A)
557 		reg |= DWC3_GCTL_U2RSTECN;
558 
559 	dwc3_core_num_eps(dwc);
560 
561 	dwc3_writel(dwc->regs, DWC3_GCTL, reg);
562 
563 	dwc3_phy_setup(dwc);
564 
565 	ret = dwc3_alloc_scratch_buffers(dwc);
566 	if (ret)
567 		goto err0;
568 
569 	ret = dwc3_setup_scratch_buffers(dwc);
570 	if (ret)
571 		goto err1;
572 
573 	return 0;
574 
575 err1:
576 	dwc3_free_scratch_buffers(dwc);
577 
578 err0:
579 	return ret;
580 }
581 
582 static void dwc3_core_exit(struct dwc3 *dwc)
583 {
584 	dwc3_free_scratch_buffers(dwc);
585 }
586 
587 static int dwc3_core_init_mode(struct dwc3 *dwc)
588 {
589 	int ret;
590 
591 	switch (dwc->dr_mode) {
592 	case USB_DR_MODE_PERIPHERAL:
593 		dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_DEVICE);
594 		ret = dwc3_gadget_init(dwc);
595 		if (ret) {
596 			dev_err(dev, "failed to initialize gadget\n");
597 			return ret;
598 		}
599 		break;
600 	case USB_DR_MODE_HOST:
601 		dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_HOST);
602 		ret = dwc3_host_init(dwc);
603 		if (ret) {
604 			dev_err(dev, "failed to initialize host\n");
605 			return ret;
606 		}
607 		break;
608 	case USB_DR_MODE_OTG:
609 		dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_OTG);
610 		ret = dwc3_host_init(dwc);
611 		if (ret) {
612 			dev_err(dev, "failed to initialize host\n");
613 			return ret;
614 		}
615 
616 		ret = dwc3_gadget_init(dwc);
617 		if (ret) {
618 			dev_err(dev, "failed to initialize gadget\n");
619 			return ret;
620 		}
621 		break;
622 	default:
623 		dev_err(dev, "Unsupported mode of operation %d\n", dwc->dr_mode);
624 		return -EINVAL;
625 	}
626 
627 	return 0;
628 }
629 
630 static void dwc3_gadget_run(struct dwc3 *dwc)
631 {
632 	dwc3_writel(dwc->regs, DWC3_DCTL, DWC3_DCTL_RUN_STOP);
633 	mdelay(100);
634 }
635 
636 static void dwc3_core_exit_mode(struct dwc3 *dwc)
637 {
638 	switch (dwc->dr_mode) {
639 	case USB_DR_MODE_PERIPHERAL:
640 		dwc3_gadget_exit(dwc);
641 		break;
642 	case USB_DR_MODE_HOST:
643 		dwc3_host_exit(dwc);
644 		break;
645 	case USB_DR_MODE_OTG:
646 		dwc3_host_exit(dwc);
647 		dwc3_gadget_exit(dwc);
648 		break;
649 	default:
650 		/* do nothing */
651 		break;
652 	}
653 
654 	/*
655 	 * switch back to peripheral mode
656 	 * This enables the phy to enter idle and then, if enabled, suspend.
657 	 */
658 	dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_DEVICE);
659 	dwc3_gadget_run(dwc);
660 }
661 
662 #define DWC3_ALIGN_MASK		(16 - 1)
663 
664 /**
665  * dwc3_uboot_init - dwc3 core uboot initialization code
666  * @dwc3_dev: struct dwc3_device containing initialization data
667  *
668  * Entry point for dwc3 driver (equivalent to dwc3_probe in linux
669  * kernel driver). Pointer to dwc3_device should be passed containing
670  * base address and other initialization data. Returns '0' on success and
671  * a negative value on failure.
672  *
673  * Generally called from board_usb_init() implemented in board file.
674  */
675 int dwc3_uboot_init(struct dwc3_device *dwc3_dev)
676 {
677 	struct dwc3		*dwc;
678 	struct device		*dev = NULL;
679 	u8			lpm_nyet_threshold;
680 	u8			tx_de_emphasis;
681 	u8			hird_threshold;
682 
683 	int			ret;
684 
685 	void			*mem;
686 	const void *blob = gd->fdt_blob;
687 	int node;
688 
689 	mem = devm_kzalloc((struct udevice *)dev,
690 			   sizeof(*dwc) + DWC3_ALIGN_MASK, GFP_KERNEL);
691 	if (!mem)
692 		return -ENOMEM;
693 
694 	dwc = PTR_ALIGN(mem, DWC3_ALIGN_MASK + 1);
695 	dwc->mem = mem;
696 
697 	dwc->regs = (void *)(uintptr_t)(dwc3_dev->base +
698 					DWC3_GLOBALS_REGS_START);
699 
700 	/* default to highest possible threshold */
701 	lpm_nyet_threshold = 0xff;
702 
703 	/* default to -3.5dB de-emphasis */
704 	tx_de_emphasis = 1;
705 
706 	/*
707 	 * default to assert utmi_sleep_n and use maximum allowed HIRD
708 	 * threshold value of 0b1100
709 	 */
710 	hird_threshold = 12;
711 
712 	dwc->maximum_speed = dwc3_dev->maximum_speed;
713 	dwc->has_lpm_erratum = dwc3_dev->has_lpm_erratum;
714 	if (dwc3_dev->lpm_nyet_threshold)
715 		lpm_nyet_threshold = dwc3_dev->lpm_nyet_threshold;
716 	dwc->is_utmi_l1_suspend = dwc3_dev->is_utmi_l1_suspend;
717 	if (dwc3_dev->hird_threshold)
718 		hird_threshold = dwc3_dev->hird_threshold;
719 
720 	dwc->needs_fifo_resize = dwc3_dev->tx_fifo_resize;
721 	dwc->dr_mode = dwc3_dev->dr_mode;
722 
723 	dwc->disable_scramble_quirk = dwc3_dev->disable_scramble_quirk;
724 	dwc->u2exit_lfps_quirk = dwc3_dev->u2exit_lfps_quirk;
725 	dwc->u2ss_inp3_quirk = dwc3_dev->u2ss_inp3_quirk;
726 	dwc->req_p1p2p3_quirk = dwc3_dev->req_p1p2p3_quirk;
727 	dwc->del_p1p2p3_quirk = dwc3_dev->del_p1p2p3_quirk;
728 	dwc->del_phy_power_chg_quirk = dwc3_dev->del_phy_power_chg_quirk;
729 	dwc->lfps_filter_quirk = dwc3_dev->lfps_filter_quirk;
730 	dwc->rx_detect_poll_quirk = dwc3_dev->rx_detect_poll_quirk;
731 	dwc->dis_u3_susphy_quirk = dwc3_dev->dis_u3_susphy_quirk;
732 	dwc->dis_u2_susphy_quirk = dwc3_dev->dis_u2_susphy_quirk;
733 	dwc->dis_u1u2_quirk = dwc3_dev->dis_u2_susphy_quirk;
734 
735 	dwc->tx_de_emphasis_quirk = dwc3_dev->tx_de_emphasis_quirk;
736 	if (dwc3_dev->tx_de_emphasis)
737 		tx_de_emphasis = dwc3_dev->tx_de_emphasis;
738 
739 	/* default to superspeed if no maximum_speed passed */
740 	if (dwc->maximum_speed == USB_SPEED_UNKNOWN)
741 		dwc->maximum_speed = USB_SPEED_SUPER;
742 
743 	dwc->lpm_nyet_threshold = lpm_nyet_threshold;
744 	dwc->tx_de_emphasis = tx_de_emphasis;
745 
746 	dwc->hird_threshold = hird_threshold
747 		| (dwc->is_utmi_l1_suspend << 4);
748 
749 	dwc->hsphy_mode = dwc3_dev->hsphy_mode;
750 
751 	dwc->index = dwc3_dev->index;
752 
753 	if (dwc3_dev->usb2_phyif_utmi_width)
754 		dwc->usb2_phyif_utmi_width = dwc3_dev->usb2_phyif_utmi_width;
755 
756 	node = fdt_node_offset_by_compatible(blob, -1,
757 			"rockchip,rk3399-xhci");
758 	if (node < 0)
759 		debug("%s dwc3 node not found\n", __func__);
760 	else
761 		dwc->usb2_phyif_utmi_width =
762 			fdtdec_get_int(blob, node, "snps,phyif-utmi-bits", -1);
763 
764 	dwc3_cache_hwparams(dwc);
765 
766 	ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
767 	if (ret) {
768 		dev_err(dwc->dev, "failed to allocate event buffers\n");
769 		return -ENOMEM;
770 	}
771 
772 	if (IS_ENABLED(CONFIG_USB_DWC3_HOST))
773 		dwc->dr_mode = USB_DR_MODE_HOST;
774 	else if (IS_ENABLED(CONFIG_USB_DWC3_GADGET))
775 		dwc->dr_mode = USB_DR_MODE_PERIPHERAL;
776 
777 	if (dwc->dr_mode == USB_DR_MODE_UNKNOWN)
778 		dwc->dr_mode = USB_DR_MODE_OTG;
779 
780 	ret = dwc3_core_init(dwc);
781 	if (ret) {
782 		dev_err(dev, "failed to initialize core\n");
783 		goto err0;
784 	}
785 
786 	ret = dwc3_event_buffers_setup(dwc);
787 	if (ret) {
788 		dev_err(dwc->dev, "failed to setup event buffers\n");
789 		goto err1;
790 	}
791 
792 	ret = dwc3_core_init_mode(dwc);
793 	if (ret)
794 		goto err2;
795 
796 	list_add_tail(&dwc->list, &dwc3_list);
797 
798 	return 0;
799 
800 err2:
801 	dwc3_event_buffers_cleanup(dwc);
802 
803 err1:
804 	dwc3_core_exit(dwc);
805 
806 err0:
807 	dwc3_free_event_buffers(dwc);
808 
809 	return ret;
810 }
811 
812 /**
813  * dwc3_uboot_exit - dwc3 core uboot cleanup code
814  * @index: index of this controller
815  *
816  * Performs cleanup of memory allocated in dwc3_uboot_init and other misc
817  * cleanups (equivalent to dwc3_remove in linux). index of _this_ controller
818  * should be passed and should match with the index passed in
819  * dwc3_device during init.
820  *
821  * Generally called from board file.
822  */
823 void dwc3_uboot_exit(int index)
824 {
825 	struct dwc3 *dwc;
826 
827 	list_for_each_entry(dwc, &dwc3_list, list) {
828 		if (dwc->index != index)
829 			continue;
830 
831 		dwc3_core_exit_mode(dwc);
832 		dwc3_event_buffers_cleanup(dwc);
833 		dwc3_free_event_buffers(dwc);
834 		dwc3_core_exit(dwc);
835 		list_del(&dwc->list);
836 		kfree(dwc->mem);
837 		break;
838 	}
839 }
840 
841 /**
842  * dwc3_uboot_handle_interrupt - handle dwc3 core interrupt
843  * @index: index of this controller
844  *
845  * Invokes dwc3 gadget interrupts.
846  *
847  * Generally called from board file.
848  */
849 void dwc3_uboot_handle_interrupt(int index)
850 {
851 	struct dwc3 *dwc = NULL;
852 
853 	list_for_each_entry(dwc, &dwc3_list, list) {
854 		if (dwc->index != index)
855 			continue;
856 
857 		dwc3_gadget_uboot_handle_interrupt(dwc);
858 		break;
859 	}
860 }
861 
862 MODULE_ALIAS("platform:dwc3");
863 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
864 MODULE_LICENSE("GPL v2");
865 MODULE_DESCRIPTION("DesignWare USB3 DRD Controller Driver");
866 
867 #if CONFIG_IS_ENABLED(PHY) && CONFIG_IS_ENABLED(DM_USB)
868 int dwc3_setup_phy(struct udevice *dev, struct phy **array, int *num_phys)
869 {
870 	int i, ret, count;
871 	struct phy *usb_phys;
872 
873 	/* Return if no phy declared */
874 	if (!dev_read_prop(dev, "phys", NULL))
875 		return 0;
876 	count = dev_count_phandle_with_args(dev, "phys", "#phy-cells");
877 	if (count <= 0)
878 		return count;
879 
880 	usb_phys = devm_kcalloc(dev, count, sizeof(struct phy),
881 				GFP_KERNEL);
882 	if (!usb_phys)
883 		return -ENOMEM;
884 
885 	for (i = 0; i < count; i++) {
886 		ret = generic_phy_get_by_index(dev, i, &usb_phys[i]);
887 		if (ret && ret != -ENOENT) {
888 			pr_err("Failed to get USB PHY%d for %s\n",
889 			       i, dev->name);
890 			return ret;
891 		}
892 	}
893 
894 	for (i = 0; i < count; i++) {
895 		ret = generic_phy_init(&usb_phys[i]);
896 		if (ret) {
897 			pr_err("Can't init USB PHY%d for %s\n",
898 			       i, dev->name);
899 			goto phys_init_err;
900 		}
901 	}
902 
903 	for (i = 0; i < count; i++) {
904 		ret = generic_phy_power_on(&usb_phys[i]);
905 		if (ret) {
906 			pr_err("Can't power USB PHY%d for %s\n",
907 			       i, dev->name);
908 			goto phys_poweron_err;
909 		}
910 	}
911 
912 	*array = usb_phys;
913 	*num_phys =  count;
914 	return 0;
915 
916 phys_poweron_err:
917 	for (i = count - 1; i >= 0; i--)
918 		generic_phy_power_off(&usb_phys[i]);
919 
920 	for (i = 0; i < count; i++)
921 		generic_phy_exit(&usb_phys[i]);
922 
923 	return ret;
924 
925 phys_init_err:
926 	for (; i >= 0; i--)
927 		generic_phy_exit(&usb_phys[i]);
928 
929 	return ret;
930 }
931 
932 int dwc3_shutdown_phy(struct udevice *dev, struct phy *usb_phys, int num_phys)
933 {
934 	int i, ret;
935 
936 	for (i = 0; i < num_phys; i++) {
937 		if (!generic_phy_valid(&usb_phys[i]))
938 			continue;
939 
940 		ret = generic_phy_power_off(&usb_phys[i]);
941 		ret |= generic_phy_exit(&usb_phys[i]);
942 		if (ret) {
943 			pr_err("Can't shutdown USB PHY%d for %s\n",
944 			       i, dev->name);
945 		}
946 	}
947 
948 	return 0;
949 }
950 #endif
951 
952 #if CONFIG_IS_ENABLED(DM_USB)
953 void dwc3_of_parse(struct dwc3 *dwc)
954 {
955 	const u8 *tmp;
956 	struct udevice *dev = dwc->dev;
957 	u8 lpm_nyet_threshold;
958 	u8 tx_de_emphasis;
959 	u8 hird_threshold;
960 
961 	/* default to highest possible threshold */
962 	lpm_nyet_threshold = 0xff;
963 
964 	/* default to -3.5dB de-emphasis */
965 	tx_de_emphasis = 1;
966 
967 	/*
968 	 * default to assert utmi_sleep_n and use maximum allowed HIRD
969 	 * threshold value of 0b1100
970 	 */
971 	hird_threshold = 12;
972 
973 	dwc->hsphy_mode = usb_get_phy_mode(dev->node);
974 
975 	dwc->has_lpm_erratum = dev_read_bool(dev,
976 				"snps,has-lpm-erratum");
977 	tmp = dev_read_u8_array_ptr(dev, "snps,lpm-nyet-threshold", 1);
978 	if (tmp)
979 		lpm_nyet_threshold = *tmp;
980 
981 	dwc->is_utmi_l1_suspend = dev_read_bool(dev,
982 				"snps,is-utmi-l1-suspend");
983 	tmp = dev_read_u8_array_ptr(dev, "snps,hird-threshold", 1);
984 	if (tmp)
985 		hird_threshold = *tmp;
986 
987 	dwc->disable_scramble_quirk = dev_read_bool(dev,
988 				"snps,disable_scramble_quirk");
989 	dwc->u2exit_lfps_quirk = dev_read_bool(dev,
990 				"snps,u2exit_lfps_quirk");
991 	dwc->u2ss_inp3_quirk = dev_read_bool(dev,
992 				"snps,u2ss_inp3_quirk");
993 	dwc->req_p1p2p3_quirk = dev_read_bool(dev,
994 				"snps,req_p1p2p3_quirk");
995 	dwc->del_p1p2p3_quirk = dev_read_bool(dev,
996 				"snps,del_p1p2p3_quirk");
997 	dwc->del_phy_power_chg_quirk = dev_read_bool(dev,
998 				"snps,del_phy_power_chg_quirk");
999 	dwc->lfps_filter_quirk = dev_read_bool(dev,
1000 				"snps,lfps_filter_quirk");
1001 	dwc->rx_detect_poll_quirk = dev_read_bool(dev,
1002 				"snps,rx_detect_poll_quirk");
1003 	dwc->dis_u3_susphy_quirk = dev_read_bool(dev,
1004 				"snps,dis_u3_susphy_quirk");
1005 	dwc->dis_u2_susphy_quirk = dev_read_bool(dev,
1006 				"snps,dis_u2_susphy_quirk");
1007 	dwc->dis_enblslpm_quirk = dev_read_bool(dev,
1008 				"snps,dis_enblslpm_quirk");
1009 	dwc->dis_u2_freeclk_exists_quirk = dev_read_bool(dev,
1010 				"snps,dis-u2-freeclk-exists-quirk");
1011 	dwc->tx_de_emphasis_quirk = dev_read_bool(dev,
1012 				"snps,tx_de_emphasis_quirk");
1013 	tmp = dev_read_u8_array_ptr(dev, "snps,tx_de_emphasis", 1);
1014 	if (tmp)
1015 		tx_de_emphasis = *tmp;
1016 
1017 	dwc->lpm_nyet_threshold = lpm_nyet_threshold;
1018 	dwc->tx_de_emphasis = tx_de_emphasis;
1019 
1020 	dwc->hird_threshold = hird_threshold
1021 		| (dwc->is_utmi_l1_suspend << 4);
1022 }
1023 
1024 int dwc3_init(struct dwc3 *dwc)
1025 {
1026 	int ret;
1027 
1028 	dwc3_cache_hwparams(dwc);
1029 
1030 	ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
1031 	if (ret) {
1032 		dev_err(dwc->dev, "failed to allocate event buffers\n");
1033 		return -ENOMEM;
1034 	}
1035 
1036 	ret = dwc3_core_init(dwc);
1037 	if (ret) {
1038 		dev_err(dev, "failed to initialize core\n");
1039 		goto core_fail;
1040 	}
1041 
1042 	ret = dwc3_event_buffers_setup(dwc);
1043 	if (ret) {
1044 		dev_err(dwc->dev, "failed to setup event buffers\n");
1045 		goto event_fail;
1046 	}
1047 
1048 	ret = dwc3_core_init_mode(dwc);
1049 	if (ret)
1050 		goto mode_fail;
1051 
1052 	return 0;
1053 
1054 mode_fail:
1055 	dwc3_event_buffers_cleanup(dwc);
1056 
1057 event_fail:
1058 	dwc3_core_exit(dwc);
1059 
1060 core_fail:
1061 	dwc3_free_event_buffers(dwc);
1062 
1063 	return ret;
1064 }
1065 
1066 void dwc3_remove(struct dwc3 *dwc)
1067 {
1068 	dwc3_core_exit_mode(dwc);
1069 	dwc3_event_buffers_cleanup(dwc);
1070 	dwc3_free_event_buffers(dwc);
1071 	dwc3_core_exit(dwc);
1072 	kfree(dwc->mem);
1073 }
1074 #endif
1075