• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
2 /*
3  * core.c - DesignWare HS OTG Controller common routines
4  *
5  * Copyright (C) 2004-2013 Synopsys, Inc.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The names of the above-listed copyright holders may not be used
17  *    to endorse or promote products derived from this software without
18  *    specific prior written permission.
19  *
20  * ALTERNATIVELY, this software may be distributed under the terms of the
21  * GNU General Public License ("GPL") as published by the Free Software
22  * Foundation; either version 2 of the License, or (at your option) any
23  * later version.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * The Core code provides basic services for accessing and managing the
40  * DWC_otg hardware. These services are used by both the Host Controller
41  * Driver and the Peripheral Controller Driver.
42  */
43 #include <linux/kernel.h>
44 #include <linux/module.h>
45 #include <linux/moduleparam.h>
46 #include <linux/spinlock.h>
47 #include <linux/interrupt.h>
48 #include <linux/dma-mapping.h>
49 #include <linux/delay.h>
50 #include <linux/io.h>
51 #include <linux/slab.h>
52 #include <linux/usb.h>
53 
54 #include <linux/usb/hcd.h>
55 #include <linux/usb/ch11.h>
56 
57 #include "core.h"
58 #include "hcd.h"
59 
60 /**
61  * dwc2_backup_global_registers() - Backup global controller registers.
62  * When suspending usb bus, registers needs to be backuped
63  * if controller power is disabled once suspended.
64  *
65  * @hsotg: Programming view of the DWC_otg controller
66  */
dwc2_backup_global_registers(struct dwc2_hsotg * hsotg)67 int dwc2_backup_global_registers(struct dwc2_hsotg *hsotg)
68 {
69 	struct dwc2_gregs_backup *gr;
70 
71 	dev_dbg(hsotg->dev, "%s\n", __func__);
72 
73 	/* Backup global regs */
74 	gr = &hsotg->gr_backup;
75 
76 	gr->gotgctl = dwc2_readl(hsotg, GOTGCTL);
77 	gr->gintmsk = dwc2_readl(hsotg, GINTMSK);
78 	gr->gahbcfg = dwc2_readl(hsotg, GAHBCFG);
79 	gr->gusbcfg = dwc2_readl(hsotg, GUSBCFG);
80 	gr->grxfsiz = dwc2_readl(hsotg, GRXFSIZ);
81 	gr->gnptxfsiz = dwc2_readl(hsotg, GNPTXFSIZ);
82 	gr->gdfifocfg = dwc2_readl(hsotg, GDFIFOCFG);
83 	gr->pcgcctl1 = dwc2_readl(hsotg, PCGCCTL1);
84 	gr->glpmcfg = dwc2_readl(hsotg, GLPMCFG);
85 	gr->gi2cctl = dwc2_readl(hsotg, GI2CCTL);
86 	gr->pcgcctl = dwc2_readl(hsotg, PCGCTL);
87 
88 	gr->valid = true;
89 	return 0;
90 }
91 
92 /**
93  * dwc2_restore_global_registers() - Restore controller global registers.
94  * When resuming usb bus, device registers needs to be restored
95  * if controller power were disabled.
96  *
97  * @hsotg: Programming view of the DWC_otg controller
98  */
dwc2_restore_global_registers(struct dwc2_hsotg * hsotg)99 int dwc2_restore_global_registers(struct dwc2_hsotg *hsotg)
100 {
101 	struct dwc2_gregs_backup *gr;
102 
103 	dev_dbg(hsotg->dev, "%s\n", __func__);
104 
105 	/* Restore global regs */
106 	gr = &hsotg->gr_backup;
107 	if (!gr->valid) {
108 		dev_err(hsotg->dev, "%s: no global registers to restore\n",
109 			__func__);
110 		return -EINVAL;
111 	}
112 	gr->valid = false;
113 
114 	dwc2_writel(hsotg, 0xffffffff, GINTSTS);
115 	dwc2_writel(hsotg, gr->gotgctl, GOTGCTL);
116 	dwc2_writel(hsotg, gr->gintmsk, GINTMSK);
117 	dwc2_writel(hsotg, gr->gusbcfg, GUSBCFG);
118 	dwc2_writel(hsotg, gr->gahbcfg, GAHBCFG);
119 	dwc2_writel(hsotg, gr->grxfsiz, GRXFSIZ);
120 	dwc2_writel(hsotg, gr->gnptxfsiz, GNPTXFSIZ);
121 	dwc2_writel(hsotg, gr->gdfifocfg, GDFIFOCFG);
122 	dwc2_writel(hsotg, gr->pcgcctl1, PCGCCTL1);
123 	dwc2_writel(hsotg, gr->glpmcfg, GLPMCFG);
124 	dwc2_writel(hsotg, gr->pcgcctl, PCGCTL);
125 	dwc2_writel(hsotg, gr->gi2cctl, GI2CCTL);
126 
127 	return 0;
128 }
129 
130 /**
131  * dwc2_exit_partial_power_down() - Exit controller from Partial Power Down.
132  *
133  * @hsotg: Programming view of the DWC_otg controller
134  * @restore: Controller registers need to be restored
135  */
dwc2_exit_partial_power_down(struct dwc2_hsotg * hsotg,bool restore)136 int dwc2_exit_partial_power_down(struct dwc2_hsotg *hsotg, bool restore)
137 {
138 	u32 pcgcctl;
139 	int ret = 0;
140 
141 	if (hsotg->params.power_down != DWC2_POWER_DOWN_PARAM_PARTIAL)
142 		return -ENOTSUPP;
143 
144 	pcgcctl = dwc2_readl(hsotg, PCGCTL);
145 	pcgcctl &= ~PCGCTL_STOPPCLK;
146 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
147 
148 	pcgcctl = dwc2_readl(hsotg, PCGCTL);
149 	pcgcctl &= ~PCGCTL_PWRCLMP;
150 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
151 
152 	pcgcctl = dwc2_readl(hsotg, PCGCTL);
153 	pcgcctl &= ~PCGCTL_RSTPDWNMODULE;
154 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
155 
156 	udelay(100);
157 	if (restore) {
158 		ret = dwc2_restore_global_registers(hsotg);
159 		if (ret) {
160 			dev_err(hsotg->dev, "%s: failed to restore registers\n",
161 				__func__);
162 			return ret;
163 		}
164 		if (dwc2_is_host_mode(hsotg)) {
165 			ret = dwc2_restore_host_registers(hsotg);
166 			if (ret) {
167 				dev_err(hsotg->dev, "%s: failed to restore host registers\n",
168 					__func__);
169 				return ret;
170 			}
171 		} else {
172 			ret = dwc2_restore_device_registers(hsotg, 0);
173 			if (ret) {
174 				dev_err(hsotg->dev, "%s: failed to restore device registers\n",
175 					__func__);
176 				return ret;
177 			}
178 		}
179 	}
180 
181 	return ret;
182 }
183 
184 /**
185  * dwc2_enter_partial_power_down() - Put controller in Partial Power Down.
186  *
187  * @hsotg: Programming view of the DWC_otg controller
188  */
dwc2_enter_partial_power_down(struct dwc2_hsotg * hsotg)189 int dwc2_enter_partial_power_down(struct dwc2_hsotg *hsotg)
190 {
191 	u32 pcgcctl;
192 	int ret = 0;
193 
194 	if (!hsotg->params.power_down)
195 		return -ENOTSUPP;
196 
197 	/* Backup all registers */
198 	ret = dwc2_backup_global_registers(hsotg);
199 	if (ret) {
200 		dev_err(hsotg->dev, "%s: failed to backup global registers\n",
201 			__func__);
202 		return ret;
203 	}
204 
205 	if (dwc2_is_host_mode(hsotg)) {
206 		ret = dwc2_backup_host_registers(hsotg);
207 		if (ret) {
208 			dev_err(hsotg->dev, "%s: failed to backup host registers\n",
209 				__func__);
210 			return ret;
211 		}
212 	} else {
213 		ret = dwc2_backup_device_registers(hsotg);
214 		if (ret) {
215 			dev_err(hsotg->dev, "%s: failed to backup device registers\n",
216 				__func__);
217 			return ret;
218 		}
219 	}
220 
221 	/*
222 	 * Clear any pending interrupts since dwc2 will not be able to
223 	 * clear them after entering partial_power_down.
224 	 */
225 	dwc2_writel(hsotg, 0xffffffff, GINTSTS);
226 
227 	/* Put the controller in low power state */
228 	pcgcctl = dwc2_readl(hsotg, PCGCTL);
229 
230 	pcgcctl |= PCGCTL_PWRCLMP;
231 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
232 	ndelay(20);
233 
234 	pcgcctl |= PCGCTL_RSTPDWNMODULE;
235 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
236 	ndelay(20);
237 
238 	pcgcctl |= PCGCTL_STOPPCLK;
239 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
240 
241 	return ret;
242 }
243 
244 /**
245  * dwc2_restore_essential_regs() - Restore essiential regs of core.
246  *
247  * @hsotg: Programming view of the DWC_otg controller
248  * @rmode: Restore mode, enabled in case of remote-wakeup.
249  * @is_host: Host or device mode.
250  */
dwc2_restore_essential_regs(struct dwc2_hsotg * hsotg,int rmode,int is_host)251 static void dwc2_restore_essential_regs(struct dwc2_hsotg *hsotg, int rmode,
252 					int is_host)
253 {
254 	u32 pcgcctl;
255 	struct dwc2_gregs_backup *gr;
256 	struct dwc2_dregs_backup *dr;
257 	struct dwc2_hregs_backup *hr;
258 
259 	gr = &hsotg->gr_backup;
260 	dr = &hsotg->dr_backup;
261 	hr = &hsotg->hr_backup;
262 
263 	dev_dbg(hsotg->dev, "%s: restoring essential regs\n", __func__);
264 
265 	/* Load restore values for [31:14] bits */
266 	pcgcctl = (gr->pcgcctl & 0xffffc000);
267 	/* If High Speed */
268 	if (is_host) {
269 		if (!(pcgcctl & PCGCTL_P2HD_PRT_SPD_MASK))
270 			pcgcctl |= BIT(17);
271 	} else {
272 		if (!(pcgcctl & PCGCTL_P2HD_DEV_ENUM_SPD_MASK))
273 			pcgcctl |= BIT(17);
274 	}
275 	dwc2_writel(hsotg, pcgcctl, PCGCTL);
276 
277 	/* Umnask global Interrupt in GAHBCFG and restore it */
278 	dwc2_writel(hsotg, gr->gahbcfg | GAHBCFG_GLBL_INTR_EN, GAHBCFG);
279 
280 	/* Clear all pending interupts */
281 	dwc2_writel(hsotg, 0xffffffff, GINTSTS);
282 
283 	/* Unmask restore done interrupt */
284 	dwc2_writel(hsotg, GINTSTS_RESTOREDONE, GINTMSK);
285 
286 	/* Restore GUSBCFG and HCFG/DCFG */
287 	dwc2_writel(hsotg, gr->gusbcfg, GUSBCFG);
288 
289 	if (is_host) {
290 		dwc2_writel(hsotg, hr->hcfg, HCFG);
291 		if (rmode)
292 			pcgcctl |= PCGCTL_RESTOREMODE;
293 		dwc2_writel(hsotg, pcgcctl, PCGCTL);
294 		udelay(10);
295 
296 		pcgcctl |= PCGCTL_ESS_REG_RESTORED;
297 		dwc2_writel(hsotg, pcgcctl, PCGCTL);
298 		udelay(10);
299 	} else {
300 		dwc2_writel(hsotg, dr->dcfg, DCFG);
301 		if (!rmode)
302 			pcgcctl |= PCGCTL_RESTOREMODE | PCGCTL_RSTPDWNMODULE;
303 		dwc2_writel(hsotg, pcgcctl, PCGCTL);
304 		udelay(10);
305 
306 		pcgcctl |= PCGCTL_ESS_REG_RESTORED;
307 		dwc2_writel(hsotg, pcgcctl, PCGCTL);
308 		udelay(10);
309 	}
310 }
311 
312 /**
313  * dwc2_hib_restore_common() - Common part of restore routine.
314  *
315  * @hsotg: Programming view of the DWC_otg controller
316  * @rem_wakeup: Remote-wakeup, enabled in case of remote-wakeup.
317  * @is_host: Host or device mode.
318  */
dwc2_hib_restore_common(struct dwc2_hsotg * hsotg,int rem_wakeup,int is_host)319 void dwc2_hib_restore_common(struct dwc2_hsotg *hsotg, int rem_wakeup,
320 			     int is_host)
321 {
322 	u32 gpwrdn;
323 
324 	/* Switch-on voltage to the core */
325 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
326 	gpwrdn &= ~GPWRDN_PWRDNSWTCH;
327 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
328 	udelay(10);
329 
330 	/* Reset core */
331 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
332 	gpwrdn &= ~GPWRDN_PWRDNRSTN;
333 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
334 	udelay(10);
335 
336 	/* Enable restore from PMU */
337 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
338 	gpwrdn |= GPWRDN_RESTORE;
339 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
340 	udelay(10);
341 
342 	/* Disable Power Down Clamp */
343 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
344 	gpwrdn &= ~GPWRDN_PWRDNCLMP;
345 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
346 	udelay(50);
347 
348 	if (!is_host && rem_wakeup)
349 		udelay(70);
350 
351 	/* Deassert reset core */
352 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
353 	gpwrdn |= GPWRDN_PWRDNRSTN;
354 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
355 	udelay(10);
356 
357 	/* Disable PMU interrupt */
358 	gpwrdn = dwc2_readl(hsotg, GPWRDN);
359 	gpwrdn &= ~GPWRDN_PMUINTSEL;
360 	dwc2_writel(hsotg, gpwrdn, GPWRDN);
361 	udelay(10);
362 
363 	/* Set Restore Essential Regs bit in PCGCCTL register */
364 	dwc2_restore_essential_regs(hsotg, rem_wakeup, is_host);
365 
366 	/*
367 	 * Wait For Restore_done Interrupt. This mechanism of polling the
368 	 * interrupt is introduced to avoid any possible race conditions
369 	 */
370 	if (dwc2_hsotg_wait_bit_set(hsotg, GINTSTS, GINTSTS_RESTOREDONE,
371 				    20000)) {
372 		dev_dbg(hsotg->dev,
373 			"%s: Restore Done wan't generated here\n",
374 			__func__);
375 	} else {
376 		dev_dbg(hsotg->dev, "restore done  generated here\n");
377 	}
378 }
379 
380 /**
381  * dwc2_wait_for_mode() - Waits for the controller mode.
382  * @hsotg:	Programming view of the DWC_otg controller.
383  * @host_mode:	If true, waits for host mode, otherwise device mode.
384  */
dwc2_wait_for_mode(struct dwc2_hsotg * hsotg,bool host_mode)385 static void dwc2_wait_for_mode(struct dwc2_hsotg *hsotg,
386 			       bool host_mode)
387 {
388 	ktime_t start;
389 	ktime_t end;
390 	unsigned int timeout = 110;
391 
392 	dev_vdbg(hsotg->dev, "Waiting for %s mode\n",
393 		 host_mode ? "host" : "device");
394 
395 	start = ktime_get();
396 
397 	while (1) {
398 		s64 ms;
399 
400 		if (dwc2_is_host_mode(hsotg) == host_mode) {
401 			dev_vdbg(hsotg->dev, "%s mode set\n",
402 				 host_mode ? "Host" : "Device");
403 			break;
404 		}
405 
406 		end = ktime_get();
407 		ms = ktime_to_ms(ktime_sub(end, start));
408 
409 		if (ms >= (s64)timeout) {
410 			dev_warn(hsotg->dev, "%s: Couldn't set %s mode\n",
411 				 __func__, host_mode ? "host" : "device");
412 			break;
413 		}
414 
415 		usleep_range(1000, 2000);
416 	}
417 }
418 
419 /**
420  * dwc2_iddig_filter_enabled() - Returns true if the IDDIG debounce
421  * filter is enabled.
422  *
423  * @hsotg: Programming view of DWC_otg controller
424  */
dwc2_iddig_filter_enabled(struct dwc2_hsotg * hsotg)425 static bool dwc2_iddig_filter_enabled(struct dwc2_hsotg *hsotg)
426 {
427 	u32 gsnpsid;
428 	u32 ghwcfg4;
429 
430 	if (!dwc2_hw_is_otg(hsotg))
431 		return false;
432 
433 	/* Check if core configuration includes the IDDIG filter. */
434 	ghwcfg4 = dwc2_readl(hsotg, GHWCFG4);
435 	if (!(ghwcfg4 & GHWCFG4_IDDIG_FILT_EN))
436 		return false;
437 
438 	/*
439 	 * Check if the IDDIG debounce filter is bypassed. Available
440 	 * in core version >= 3.10a.
441 	 */
442 	gsnpsid = dwc2_readl(hsotg, GSNPSID);
443 	if (gsnpsid >= DWC2_CORE_REV_3_10a) {
444 		u32 gotgctl = dwc2_readl(hsotg, GOTGCTL);
445 
446 		if (gotgctl & GOTGCTL_DBNCE_FLTR_BYPASS)
447 			return false;
448 	}
449 
450 	return true;
451 }
452 
453 /*
454  * dwc2_enter_hibernation() - Common function to enter hibernation.
455  *
456  * @hsotg: Programming view of the DWC_otg controller
457  * @is_host: True if core is in host mode.
458  *
459  * Return: 0 if successful, negative error code otherwise
460  */
dwc2_enter_hibernation(struct dwc2_hsotg * hsotg,int is_host)461 int dwc2_enter_hibernation(struct dwc2_hsotg *hsotg, int is_host)
462 {
463 	if (hsotg->params.power_down != DWC2_POWER_DOWN_PARAM_HIBERNATION)
464 		return -ENOTSUPP;
465 
466 	if (is_host)
467 		return dwc2_host_enter_hibernation(hsotg);
468 	else
469 		return dwc2_gadget_enter_hibernation(hsotg);
470 }
471 
472 /*
473  * dwc2_exit_hibernation() - Common function to exit from hibernation.
474  *
475  * @hsotg: Programming view of the DWC_otg controller
476  * @rem_wakeup: Remote-wakeup, enabled in case of remote-wakeup.
477  * @reset: Enabled in case of restore with reset.
478  * @is_host: True if core is in host mode.
479  *
480  * Return: 0 if successful, negative error code otherwise
481  */
dwc2_exit_hibernation(struct dwc2_hsotg * hsotg,int rem_wakeup,int reset,int is_host)482 int dwc2_exit_hibernation(struct dwc2_hsotg *hsotg, int rem_wakeup,
483 			  int reset, int is_host)
484 {
485 	if (is_host)
486 		return dwc2_host_exit_hibernation(hsotg, rem_wakeup, reset);
487 	else
488 		return dwc2_gadget_exit_hibernation(hsotg, rem_wakeup, reset);
489 }
490 
491 /*
492  * Do core a soft reset of the core.  Be careful with this because it
493  * resets all the internal state machines of the core.
494  */
dwc2_core_reset(struct dwc2_hsotg * hsotg,bool skip_wait)495 int dwc2_core_reset(struct dwc2_hsotg *hsotg, bool skip_wait)
496 {
497 	u32 greset;
498 	bool wait_for_host_mode = false;
499 
500 	dev_vdbg(hsotg->dev, "%s()\n", __func__);
501 
502 	/*
503 	 * If the current mode is host, either due to the force mode
504 	 * bit being set (which persists after core reset) or the
505 	 * connector id pin, a core soft reset will temporarily reset
506 	 * the mode to device. A delay from the IDDIG debounce filter
507 	 * will occur before going back to host mode.
508 	 *
509 	 * Determine whether we will go back into host mode after a
510 	 * reset and account for this delay after the reset.
511 	 */
512 	if (dwc2_iddig_filter_enabled(hsotg)) {
513 		u32 gotgctl = dwc2_readl(hsotg, GOTGCTL);
514 		u32 gusbcfg = dwc2_readl(hsotg, GUSBCFG);
515 
516 		if (!(gotgctl & GOTGCTL_CONID_B) ||
517 		    (gusbcfg & GUSBCFG_FORCEHOSTMODE)) {
518 			wait_for_host_mode = true;
519 		}
520 	}
521 
522 	/* Core Soft Reset */
523 	greset = dwc2_readl(hsotg, GRSTCTL);
524 	greset |= GRSTCTL_CSFTRST;
525 	dwc2_writel(hsotg, greset, GRSTCTL);
526 
527 	if ((hsotg->hw_params.snpsid & DWC2_CORE_REV_MASK) <
528 		(DWC2_CORE_REV_4_20a & DWC2_CORE_REV_MASK)) {
529 		if (dwc2_hsotg_wait_bit_clear(hsotg, GRSTCTL,
530 					      GRSTCTL_CSFTRST, 10000)) {
531 			dev_warn(hsotg->dev, "%s: HANG! Soft Reset timeout GRSTCTL_CSFTRST\n",
532 				 __func__);
533 			return -EBUSY;
534 		}
535 	} else {
536 		if (dwc2_hsotg_wait_bit_set(hsotg, GRSTCTL,
537 					    GRSTCTL_CSFTRST_DONE, 10000)) {
538 			dev_warn(hsotg->dev, "%s: HANG! Soft Reset timeout GRSTCTL_CSFTRST_DONE\n",
539 				 __func__);
540 			return -EBUSY;
541 		}
542 		greset = dwc2_readl(hsotg, GRSTCTL);
543 		greset &= ~GRSTCTL_CSFTRST;
544 		greset |= GRSTCTL_CSFTRST_DONE;
545 		dwc2_writel(hsotg, greset, GRSTCTL);
546 	}
547 
548 	/* Wait for AHB master IDLE state */
549 	if (dwc2_hsotg_wait_bit_set(hsotg, GRSTCTL, GRSTCTL_AHBIDLE, 10000)) {
550 		dev_warn(hsotg->dev, "%s: HANG! AHB Idle timeout GRSTCTL GRSTCTL_AHBIDLE\n",
551 			 __func__);
552 		return -EBUSY;
553 	}
554 
555 	if (wait_for_host_mode && !skip_wait)
556 		dwc2_wait_for_mode(hsotg, true);
557 
558 	return 0;
559 }
560 
561 /**
562  * dwc2_force_mode() - Force the mode of the controller.
563  *
564  * Forcing the mode is needed for two cases:
565  *
566  * 1) If the dr_mode is set to either HOST or PERIPHERAL we force the
567  * controller to stay in a particular mode regardless of ID pin
568  * changes. We do this once during probe.
569  *
570  * 2) During probe we want to read reset values of the hw
571  * configuration registers that are only available in either host or
572  * device mode. We may need to force the mode if the current mode does
573  * not allow us to access the register in the mode that we want.
574  *
575  * In either case it only makes sense to force the mode if the
576  * controller hardware is OTG capable.
577  *
578  * Checks are done in this function to determine whether doing a force
579  * would be valid or not.
580  *
581  * If a force is done, it requires a IDDIG debounce filter delay if
582  * the filter is configured and enabled. We poll the current mode of
583  * the controller to account for this delay.
584  *
585  * @hsotg: Programming view of DWC_otg controller
586  * @host: Host mode flag
587  */
dwc2_force_mode(struct dwc2_hsotg * hsotg,bool host)588 void dwc2_force_mode(struct dwc2_hsotg *hsotg, bool host)
589 {
590 	u32 gusbcfg;
591 	u32 set;
592 	u32 clear;
593 
594 	dev_dbg(hsotg->dev, "Forcing mode to %s\n", host ? "host" : "device");
595 
596 	/*
597 	 * Force mode has no effect if the hardware is not OTG.
598 	 */
599 	if (!dwc2_hw_is_otg(hsotg))
600 		return;
601 
602 	/*
603 	 * If dr_mode is either peripheral or host only, there is no
604 	 * need to ever force the mode to the opposite mode.
605 	 */
606 	if (WARN_ON(host && hsotg->dr_mode == USB_DR_MODE_PERIPHERAL))
607 		return;
608 
609 	if (WARN_ON(!host && hsotg->dr_mode == USB_DR_MODE_HOST))
610 		return;
611 
612 	gusbcfg = dwc2_readl(hsotg, GUSBCFG);
613 
614 	set = host ? GUSBCFG_FORCEHOSTMODE : GUSBCFG_FORCEDEVMODE;
615 	clear = host ? GUSBCFG_FORCEDEVMODE : GUSBCFG_FORCEHOSTMODE;
616 
617 	gusbcfg &= ~clear;
618 	gusbcfg |= set;
619 	dwc2_writel(hsotg, gusbcfg, GUSBCFG);
620 
621 	dwc2_wait_for_mode(hsotg, host);
622 	return;
623 }
624 
625 /**
626  * dwc2_clear_force_mode() - Clears the force mode bits.
627  *
628  * After clearing the bits, wait up to 100 ms to account for any
629  * potential IDDIG filter delay. We can't know if we expect this delay
630  * or not because the value of the connector ID status is affected by
631  * the force mode. We only need to call this once during probe if
632  * dr_mode == OTG.
633  *
634  * @hsotg: Programming view of DWC_otg controller
635  */
dwc2_clear_force_mode(struct dwc2_hsotg * hsotg)636 static void dwc2_clear_force_mode(struct dwc2_hsotg *hsotg)
637 {
638 	u32 gusbcfg;
639 
640 	if (!dwc2_hw_is_otg(hsotg))
641 		return;
642 
643 	dev_dbg(hsotg->dev, "Clearing force mode bits\n");
644 
645 	gusbcfg = dwc2_readl(hsotg, GUSBCFG);
646 	gusbcfg &= ~GUSBCFG_FORCEHOSTMODE;
647 	gusbcfg &= ~GUSBCFG_FORCEDEVMODE;
648 	dwc2_writel(hsotg, gusbcfg, GUSBCFG);
649 
650 	if (dwc2_iddig_filter_enabled(hsotg))
651 		msleep(100);
652 }
653 
654 /*
655  * Sets or clears force mode based on the dr_mode parameter.
656  */
dwc2_force_dr_mode(struct dwc2_hsotg * hsotg)657 void dwc2_force_dr_mode(struct dwc2_hsotg *hsotg)
658 {
659 	switch (hsotg->dr_mode) {
660 	case USB_DR_MODE_HOST:
661 		/*
662 		 * NOTE: This is required for some rockchip soc based
663 		 * platforms on their host-only dwc2.
664 		 */
665 		if (!dwc2_hw_is_otg(hsotg))
666 			msleep(50);
667 
668 		break;
669 	case USB_DR_MODE_PERIPHERAL:
670 		dwc2_force_mode(hsotg, false);
671 		break;
672 	case USB_DR_MODE_OTG:
673 		dwc2_clear_force_mode(hsotg);
674 		break;
675 	default:
676 		dev_warn(hsotg->dev, "%s() Invalid dr_mode=%d\n",
677 			 __func__, hsotg->dr_mode);
678 		break;
679 	}
680 }
681 
682 /*
683  * dwc2_enable_acg - enable active clock gating feature
684  */
dwc2_enable_acg(struct dwc2_hsotg * hsotg)685 void dwc2_enable_acg(struct dwc2_hsotg *hsotg)
686 {
687 	if (hsotg->params.acg_enable) {
688 		u32 pcgcctl1 = dwc2_readl(hsotg, PCGCCTL1);
689 
690 		dev_dbg(hsotg->dev, "Enabling Active Clock Gating\n");
691 		pcgcctl1 |= PCGCCTL1_GATEEN;
692 		dwc2_writel(hsotg, pcgcctl1, PCGCCTL1);
693 	}
694 }
695 
696 /**
697  * dwc2_dump_host_registers() - Prints the host registers
698  *
699  * @hsotg: Programming view of DWC_otg controller
700  *
701  * NOTE: This function will be removed once the peripheral controller code
702  * is integrated and the driver is stable
703  */
dwc2_dump_host_registers(struct dwc2_hsotg * hsotg)704 void dwc2_dump_host_registers(struct dwc2_hsotg *hsotg)
705 {
706 #ifdef DEBUG
707 	u32 __iomem *addr;
708 	int i;
709 
710 	dev_dbg(hsotg->dev, "Host Global Registers\n");
711 	addr = hsotg->regs + HCFG;
712 	dev_dbg(hsotg->dev, "HCFG	 @0x%08lX : 0x%08X\n",
713 		(unsigned long)addr, dwc2_readl(hsotg, HCFG));
714 	addr = hsotg->regs + HFIR;
715 	dev_dbg(hsotg->dev, "HFIR	 @0x%08lX : 0x%08X\n",
716 		(unsigned long)addr, dwc2_readl(hsotg, HFIR));
717 	addr = hsotg->regs + HFNUM;
718 	dev_dbg(hsotg->dev, "HFNUM	 @0x%08lX : 0x%08X\n",
719 		(unsigned long)addr, dwc2_readl(hsotg, HFNUM));
720 	addr = hsotg->regs + HPTXSTS;
721 	dev_dbg(hsotg->dev, "HPTXSTS	 @0x%08lX : 0x%08X\n",
722 		(unsigned long)addr, dwc2_readl(hsotg, HPTXSTS));
723 	addr = hsotg->regs + HAINT;
724 	dev_dbg(hsotg->dev, "HAINT	 @0x%08lX : 0x%08X\n",
725 		(unsigned long)addr, dwc2_readl(hsotg, HAINT));
726 	addr = hsotg->regs + HAINTMSK;
727 	dev_dbg(hsotg->dev, "HAINTMSK	 @0x%08lX : 0x%08X\n",
728 		(unsigned long)addr, dwc2_readl(hsotg, HAINTMSK));
729 	if (hsotg->params.dma_desc_enable) {
730 		addr = hsotg->regs + HFLBADDR;
731 		dev_dbg(hsotg->dev, "HFLBADDR @0x%08lX : 0x%08X\n",
732 			(unsigned long)addr, dwc2_readl(hsotg, HFLBADDR));
733 	}
734 
735 	addr = hsotg->regs + HPRT0;
736 	dev_dbg(hsotg->dev, "HPRT0	 @0x%08lX : 0x%08X\n",
737 		(unsigned long)addr, dwc2_readl(hsotg, HPRT0));
738 
739 	for (i = 0; i < hsotg->params.host_channels; i++) {
740 		dev_dbg(hsotg->dev, "Host Channel %d Specific Registers\n", i);
741 		addr = hsotg->regs + HCCHAR(i);
742 		dev_dbg(hsotg->dev, "HCCHAR	 @0x%08lX : 0x%08X\n",
743 			(unsigned long)addr, dwc2_readl(hsotg, HCCHAR(i)));
744 		addr = hsotg->regs + HCSPLT(i);
745 		dev_dbg(hsotg->dev, "HCSPLT	 @0x%08lX : 0x%08X\n",
746 			(unsigned long)addr, dwc2_readl(hsotg, HCSPLT(i)));
747 		addr = hsotg->regs + HCINT(i);
748 		dev_dbg(hsotg->dev, "HCINT	 @0x%08lX : 0x%08X\n",
749 			(unsigned long)addr, dwc2_readl(hsotg, HCINT(i)));
750 		addr = hsotg->regs + HCINTMSK(i);
751 		dev_dbg(hsotg->dev, "HCINTMSK	 @0x%08lX : 0x%08X\n",
752 			(unsigned long)addr, dwc2_readl(hsotg, HCINTMSK(i)));
753 		addr = hsotg->regs + HCTSIZ(i);
754 		dev_dbg(hsotg->dev, "HCTSIZ	 @0x%08lX : 0x%08X\n",
755 			(unsigned long)addr, dwc2_readl(hsotg, HCTSIZ(i)));
756 		addr = hsotg->regs + HCDMA(i);
757 		dev_dbg(hsotg->dev, "HCDMA	 @0x%08lX : 0x%08X\n",
758 			(unsigned long)addr, dwc2_readl(hsotg, HCDMA(i)));
759 		if (hsotg->params.dma_desc_enable) {
760 			addr = hsotg->regs + HCDMAB(i);
761 			dev_dbg(hsotg->dev, "HCDMAB	 @0x%08lX : 0x%08X\n",
762 				(unsigned long)addr, dwc2_readl(hsotg,
763 								HCDMAB(i)));
764 		}
765 	}
766 #endif
767 }
768 
769 /**
770  * dwc2_dump_global_registers() - Prints the core global registers
771  *
772  * @hsotg: Programming view of DWC_otg controller
773  *
774  * NOTE: This function will be removed once the peripheral controller code
775  * is integrated and the driver is stable
776  */
dwc2_dump_global_registers(struct dwc2_hsotg * hsotg)777 void dwc2_dump_global_registers(struct dwc2_hsotg *hsotg)
778 {
779 #ifdef DEBUG
780 	u32 __iomem *addr;
781 
782 	dev_dbg(hsotg->dev, "Core Global Registers\n");
783 	addr = hsotg->regs + GOTGCTL;
784 	dev_dbg(hsotg->dev, "GOTGCTL	 @0x%08lX : 0x%08X\n",
785 		(unsigned long)addr, dwc2_readl(hsotg, GOTGCTL));
786 	addr = hsotg->regs + GOTGINT;
787 	dev_dbg(hsotg->dev, "GOTGINT	 @0x%08lX : 0x%08X\n",
788 		(unsigned long)addr, dwc2_readl(hsotg, GOTGINT));
789 	addr = hsotg->regs + GAHBCFG;
790 	dev_dbg(hsotg->dev, "GAHBCFG	 @0x%08lX : 0x%08X\n",
791 		(unsigned long)addr, dwc2_readl(hsotg, GAHBCFG));
792 	addr = hsotg->regs + GUSBCFG;
793 	dev_dbg(hsotg->dev, "GUSBCFG	 @0x%08lX : 0x%08X\n",
794 		(unsigned long)addr, dwc2_readl(hsotg, GUSBCFG));
795 	addr = hsotg->regs + GRSTCTL;
796 	dev_dbg(hsotg->dev, "GRSTCTL	 @0x%08lX : 0x%08X\n",
797 		(unsigned long)addr, dwc2_readl(hsotg, GRSTCTL));
798 	addr = hsotg->regs + GINTSTS;
799 	dev_dbg(hsotg->dev, "GINTSTS	 @0x%08lX : 0x%08X\n",
800 		(unsigned long)addr, dwc2_readl(hsotg, GINTSTS));
801 	addr = hsotg->regs + GINTMSK;
802 	dev_dbg(hsotg->dev, "GINTMSK	 @0x%08lX : 0x%08X\n",
803 		(unsigned long)addr, dwc2_readl(hsotg, GINTMSK));
804 	addr = hsotg->regs + GRXSTSR;
805 	dev_dbg(hsotg->dev, "GRXSTSR	 @0x%08lX : 0x%08X\n",
806 		(unsigned long)addr, dwc2_readl(hsotg, GRXSTSR));
807 	addr = hsotg->regs + GRXFSIZ;
808 	dev_dbg(hsotg->dev, "GRXFSIZ	 @0x%08lX : 0x%08X\n",
809 		(unsigned long)addr, dwc2_readl(hsotg, GRXFSIZ));
810 	addr = hsotg->regs + GNPTXFSIZ;
811 	dev_dbg(hsotg->dev, "GNPTXFSIZ	 @0x%08lX : 0x%08X\n",
812 		(unsigned long)addr, dwc2_readl(hsotg, GNPTXFSIZ));
813 	addr = hsotg->regs + GNPTXSTS;
814 	dev_dbg(hsotg->dev, "GNPTXSTS	 @0x%08lX : 0x%08X\n",
815 		(unsigned long)addr, dwc2_readl(hsotg, GNPTXSTS));
816 	addr = hsotg->regs + GI2CCTL;
817 	dev_dbg(hsotg->dev, "GI2CCTL	 @0x%08lX : 0x%08X\n",
818 		(unsigned long)addr, dwc2_readl(hsotg, GI2CCTL));
819 	addr = hsotg->regs + GPVNDCTL;
820 	dev_dbg(hsotg->dev, "GPVNDCTL	 @0x%08lX : 0x%08X\n",
821 		(unsigned long)addr, dwc2_readl(hsotg, GPVNDCTL));
822 	addr = hsotg->regs + GGPIO;
823 	dev_dbg(hsotg->dev, "GGPIO	 @0x%08lX : 0x%08X\n",
824 		(unsigned long)addr, dwc2_readl(hsotg, GGPIO));
825 	addr = hsotg->regs + GUID;
826 	dev_dbg(hsotg->dev, "GUID	 @0x%08lX : 0x%08X\n",
827 		(unsigned long)addr, dwc2_readl(hsotg, GUID));
828 	addr = hsotg->regs + GSNPSID;
829 	dev_dbg(hsotg->dev, "GSNPSID	 @0x%08lX : 0x%08X\n",
830 		(unsigned long)addr, dwc2_readl(hsotg, GSNPSID));
831 	addr = hsotg->regs + GHWCFG1;
832 	dev_dbg(hsotg->dev, "GHWCFG1	 @0x%08lX : 0x%08X\n",
833 		(unsigned long)addr, dwc2_readl(hsotg, GHWCFG1));
834 	addr = hsotg->regs + GHWCFG2;
835 	dev_dbg(hsotg->dev, "GHWCFG2	 @0x%08lX : 0x%08X\n",
836 		(unsigned long)addr, dwc2_readl(hsotg, GHWCFG2));
837 	addr = hsotg->regs + GHWCFG3;
838 	dev_dbg(hsotg->dev, "GHWCFG3	 @0x%08lX : 0x%08X\n",
839 		(unsigned long)addr, dwc2_readl(hsotg, GHWCFG3));
840 	addr = hsotg->regs + GHWCFG4;
841 	dev_dbg(hsotg->dev, "GHWCFG4	 @0x%08lX : 0x%08X\n",
842 		(unsigned long)addr, dwc2_readl(hsotg, GHWCFG4));
843 	addr = hsotg->regs + GLPMCFG;
844 	dev_dbg(hsotg->dev, "GLPMCFG	 @0x%08lX : 0x%08X\n",
845 		(unsigned long)addr, dwc2_readl(hsotg, GLPMCFG));
846 	addr = hsotg->regs + GPWRDN;
847 	dev_dbg(hsotg->dev, "GPWRDN	 @0x%08lX : 0x%08X\n",
848 		(unsigned long)addr, dwc2_readl(hsotg, GPWRDN));
849 	addr = hsotg->regs + GDFIFOCFG;
850 	dev_dbg(hsotg->dev, "GDFIFOCFG	 @0x%08lX : 0x%08X\n",
851 		(unsigned long)addr, dwc2_readl(hsotg, GDFIFOCFG));
852 	addr = hsotg->regs + HPTXFSIZ;
853 	dev_dbg(hsotg->dev, "HPTXFSIZ	 @0x%08lX : 0x%08X\n",
854 		(unsigned long)addr, dwc2_readl(hsotg, HPTXFSIZ));
855 
856 	addr = hsotg->regs + PCGCTL;
857 	dev_dbg(hsotg->dev, "PCGCTL	 @0x%08lX : 0x%08X\n",
858 		(unsigned long)addr, dwc2_readl(hsotg, PCGCTL));
859 #endif
860 }
861 
862 /**
863  * dwc2_flush_tx_fifo() - Flushes a Tx FIFO
864  *
865  * @hsotg: Programming view of DWC_otg controller
866  * @num:   Tx FIFO to flush
867  */
dwc2_flush_tx_fifo(struct dwc2_hsotg * hsotg,const int num)868 void dwc2_flush_tx_fifo(struct dwc2_hsotg *hsotg, const int num)
869 {
870 	u32 greset;
871 
872 	dev_vdbg(hsotg->dev, "Flush Tx FIFO %d\n", num);
873 
874 	/* Wait for AHB master IDLE state */
875 	if (dwc2_hsotg_wait_bit_set(hsotg, GRSTCTL, GRSTCTL_AHBIDLE, 10000))
876 		dev_warn(hsotg->dev, "%s:  HANG! AHB Idle GRSCTL\n",
877 			 __func__);
878 
879 	greset = GRSTCTL_TXFFLSH;
880 	greset |= num << GRSTCTL_TXFNUM_SHIFT & GRSTCTL_TXFNUM_MASK;
881 	dwc2_writel(hsotg, greset, GRSTCTL);
882 
883 	if (dwc2_hsotg_wait_bit_clear(hsotg, GRSTCTL, GRSTCTL_TXFFLSH, 10000))
884 		dev_warn(hsotg->dev, "%s:  HANG! timeout GRSTCTL GRSTCTL_TXFFLSH\n",
885 			 __func__);
886 
887 	/* Wait for at least 3 PHY Clocks */
888 	udelay(1);
889 }
890 
891 /**
892  * dwc2_flush_rx_fifo() - Flushes the Rx FIFO
893  *
894  * @hsotg: Programming view of DWC_otg controller
895  */
dwc2_flush_rx_fifo(struct dwc2_hsotg * hsotg)896 void dwc2_flush_rx_fifo(struct dwc2_hsotg *hsotg)
897 {
898 	u32 greset;
899 
900 	dev_vdbg(hsotg->dev, "%s()\n", __func__);
901 
902 	/* Wait for AHB master IDLE state */
903 	if (dwc2_hsotg_wait_bit_set(hsotg, GRSTCTL, GRSTCTL_AHBIDLE, 10000))
904 		dev_warn(hsotg->dev, "%s:  HANG! AHB Idle GRSCTL\n",
905 			 __func__);
906 
907 	greset = GRSTCTL_RXFFLSH;
908 	dwc2_writel(hsotg, greset, GRSTCTL);
909 
910 	/* Wait for RxFIFO flush done */
911 	if (dwc2_hsotg_wait_bit_clear(hsotg, GRSTCTL, GRSTCTL_RXFFLSH, 10000))
912 		dev_warn(hsotg->dev, "%s: HANG! timeout GRSTCTL GRSTCTL_RXFFLSH\n",
913 			 __func__);
914 
915 	/* Wait for at least 3 PHY Clocks */
916 	udelay(1);
917 }
918 
dwc2_is_controller_alive(struct dwc2_hsotg * hsotg)919 bool dwc2_is_controller_alive(struct dwc2_hsotg *hsotg)
920 {
921 	if (dwc2_readl(hsotg, GSNPSID) == 0xffffffff)
922 		return false;
923 	else
924 		return true;
925 }
926 
927 /**
928  * dwc2_enable_global_interrupts() - Enables the controller's Global
929  * Interrupt in the AHB Config register
930  *
931  * @hsotg: Programming view of DWC_otg controller
932  */
dwc2_enable_global_interrupts(struct dwc2_hsotg * hsotg)933 void dwc2_enable_global_interrupts(struct dwc2_hsotg *hsotg)
934 {
935 	u32 ahbcfg = dwc2_readl(hsotg, GAHBCFG);
936 
937 	ahbcfg |= GAHBCFG_GLBL_INTR_EN;
938 	dwc2_writel(hsotg, ahbcfg, GAHBCFG);
939 }
940 
941 /**
942  * dwc2_disable_global_interrupts() - Disables the controller's Global
943  * Interrupt in the AHB Config register
944  *
945  * @hsotg: Programming view of DWC_otg controller
946  */
dwc2_disable_global_interrupts(struct dwc2_hsotg * hsotg)947 void dwc2_disable_global_interrupts(struct dwc2_hsotg *hsotg)
948 {
949 	u32 ahbcfg = dwc2_readl(hsotg, GAHBCFG);
950 
951 	ahbcfg &= ~GAHBCFG_GLBL_INTR_EN;
952 	dwc2_writel(hsotg, ahbcfg, GAHBCFG);
953 }
954 
955 /* Returns the controller's GHWCFG2.OTG_MODE. */
dwc2_op_mode(struct dwc2_hsotg * hsotg)956 unsigned int dwc2_op_mode(struct dwc2_hsotg *hsotg)
957 {
958 	u32 ghwcfg2 = dwc2_readl(hsotg, GHWCFG2);
959 
960 	return (ghwcfg2 & GHWCFG2_OP_MODE_MASK) >>
961 		GHWCFG2_OP_MODE_SHIFT;
962 }
963 
964 /* Returns true if the controller is capable of DRD. */
dwc2_hw_is_otg(struct dwc2_hsotg * hsotg)965 bool dwc2_hw_is_otg(struct dwc2_hsotg *hsotg)
966 {
967 	unsigned int op_mode = dwc2_op_mode(hsotg);
968 
969 	return (op_mode == GHWCFG2_OP_MODE_HNP_SRP_CAPABLE) ||
970 		(op_mode == GHWCFG2_OP_MODE_SRP_ONLY_CAPABLE) ||
971 		(op_mode == GHWCFG2_OP_MODE_NO_HNP_SRP_CAPABLE);
972 }
973 
974 /* Returns true if the controller is host-only. */
dwc2_hw_is_host(struct dwc2_hsotg * hsotg)975 bool dwc2_hw_is_host(struct dwc2_hsotg *hsotg)
976 {
977 	unsigned int op_mode = dwc2_op_mode(hsotg);
978 
979 	return (op_mode == GHWCFG2_OP_MODE_SRP_CAPABLE_HOST) ||
980 		(op_mode == GHWCFG2_OP_MODE_NO_SRP_CAPABLE_HOST);
981 }
982 
983 /* Returns true if the controller is device-only. */
dwc2_hw_is_device(struct dwc2_hsotg * hsotg)984 bool dwc2_hw_is_device(struct dwc2_hsotg *hsotg)
985 {
986 	unsigned int op_mode = dwc2_op_mode(hsotg);
987 
988 	return (op_mode == GHWCFG2_OP_MODE_SRP_CAPABLE_DEVICE) ||
989 		(op_mode == GHWCFG2_OP_MODE_NO_SRP_CAPABLE_DEVICE);
990 }
991 
992 /**
993  * dwc2_hsotg_wait_bit_set - Waits for bit to be set.
994  * @hsotg: Programming view of DWC_otg controller.
995  * @offset: Register's offset where bit/bits must be set.
996  * @mask: Mask of the bit/bits which must be set.
997  * @timeout: Timeout to wait.
998  *
999  * Return: 0 if bit/bits are set or -ETIMEDOUT in case of timeout.
1000  */
dwc2_hsotg_wait_bit_set(struct dwc2_hsotg * hsotg,u32 offset,u32 mask,u32 timeout)1001 int dwc2_hsotg_wait_bit_set(struct dwc2_hsotg *hsotg, u32 offset, u32 mask,
1002 			    u32 timeout)
1003 {
1004 	u32 i;
1005 
1006 	for (i = 0; i < timeout; i++) {
1007 		if (dwc2_readl(hsotg, offset) & mask)
1008 			return 0;
1009 		udelay(1);
1010 	}
1011 
1012 	return -ETIMEDOUT;
1013 }
1014 
1015 /**
1016  * dwc2_hsotg_wait_bit_clear - Waits for bit to be clear.
1017  * @hsotg: Programming view of DWC_otg controller.
1018  * @offset: Register's offset where bit/bits must be set.
1019  * @mask: Mask of the bit/bits which must be set.
1020  * @timeout: Timeout to wait.
1021  *
1022  * Return: 0 if bit/bits are set or -ETIMEDOUT in case of timeout.
1023  */
dwc2_hsotg_wait_bit_clear(struct dwc2_hsotg * hsotg,u32 offset,u32 mask,u32 timeout)1024 int dwc2_hsotg_wait_bit_clear(struct dwc2_hsotg *hsotg, u32 offset, u32 mask,
1025 			      u32 timeout)
1026 {
1027 	u32 i;
1028 
1029 	for (i = 0; i < timeout; i++) {
1030 		if (!(dwc2_readl(hsotg, offset) & mask))
1031 			return 0;
1032 		udelay(1);
1033 	}
1034 
1035 	return -ETIMEDOUT;
1036 }
1037 
1038 /*
1039  * Initializes the FSLSPClkSel field of the HCFG register depending on the
1040  * PHY type
1041  */
dwc2_init_fs_ls_pclk_sel(struct dwc2_hsotg * hsotg)1042 void dwc2_init_fs_ls_pclk_sel(struct dwc2_hsotg *hsotg)
1043 {
1044 	u32 hcfg, val;
1045 
1046 	if ((hsotg->hw_params.hs_phy_type == GHWCFG2_HS_PHY_TYPE_ULPI &&
1047 	     hsotg->hw_params.fs_phy_type == GHWCFG2_FS_PHY_TYPE_DEDICATED &&
1048 	     hsotg->params.ulpi_fs_ls) ||
1049 	    hsotg->params.phy_type == DWC2_PHY_TYPE_PARAM_FS) {
1050 		/* Full speed PHY */
1051 		val = HCFG_FSLSPCLKSEL_48_MHZ;
1052 	} else {
1053 		/* High speed PHY running at full speed or high speed */
1054 		val = HCFG_FSLSPCLKSEL_30_60_MHZ;
1055 	}
1056 
1057 	dev_dbg(hsotg->dev, "Initializing HCFG.FSLSPClkSel to %08x\n", val);
1058 	hcfg = dwc2_readl(hsotg, HCFG);
1059 	hcfg &= ~HCFG_FSLSPCLKSEL_MASK;
1060 	hcfg |= val << HCFG_FSLSPCLKSEL_SHIFT;
1061 	dwc2_writel(hsotg, hcfg, HCFG);
1062 }
1063 
dwc2_fs_phy_init(struct dwc2_hsotg * hsotg,bool select_phy)1064 static int dwc2_fs_phy_init(struct dwc2_hsotg *hsotg, bool select_phy)
1065 {
1066 	u32 usbcfg, ggpio, i2cctl;
1067 	int retval = 0;
1068 
1069 	/*
1070 	 * core_init() is now called on every switch so only call the
1071 	 * following for the first time through
1072 	 */
1073 	if (select_phy) {
1074 		dev_dbg(hsotg->dev, "FS PHY selected\n");
1075 
1076 		usbcfg = dwc2_readl(hsotg, GUSBCFG);
1077 		if (!(usbcfg & GUSBCFG_PHYSEL)) {
1078 			usbcfg |= GUSBCFG_PHYSEL;
1079 			dwc2_writel(hsotg, usbcfg, GUSBCFG);
1080 
1081 			/* Reset after a PHY select */
1082 			retval = dwc2_core_reset(hsotg, false);
1083 
1084 			if (retval) {
1085 				dev_err(hsotg->dev,
1086 					"%s: Reset failed, aborting", __func__);
1087 				return retval;
1088 			}
1089 		}
1090 
1091 		if (hsotg->params.activate_stm_fs_transceiver) {
1092 			ggpio = dwc2_readl(hsotg, GGPIO);
1093 			if (!(ggpio & GGPIO_STM32_OTG_GCCFG_PWRDWN)) {
1094 				dev_dbg(hsotg->dev, "Activating transceiver\n");
1095 				/*
1096 				 * STM32F4x9 uses the GGPIO register as general
1097 				 * core configuration register.
1098 				 */
1099 				ggpio |= GGPIO_STM32_OTG_GCCFG_PWRDWN;
1100 				dwc2_writel(hsotg, ggpio, GGPIO);
1101 			}
1102 		}
1103 	}
1104 
1105 	/*
1106 	 * Program DCFG.DevSpd or HCFG.FSLSPclkSel to 48Mhz in FS. Also
1107 	 * do this on HNP Dev/Host mode switches (done in dev_init and
1108 	 * host_init).
1109 	 */
1110 	if (dwc2_is_host_mode(hsotg))
1111 		dwc2_init_fs_ls_pclk_sel(hsotg);
1112 
1113 	if (hsotg->params.i2c_enable) {
1114 		dev_dbg(hsotg->dev, "FS PHY enabling I2C\n");
1115 
1116 		/* Program GUSBCFG.OtgUtmiFsSel to I2C */
1117 		usbcfg = dwc2_readl(hsotg, GUSBCFG);
1118 		usbcfg |= GUSBCFG_OTG_UTMI_FS_SEL;
1119 		dwc2_writel(hsotg, usbcfg, GUSBCFG);
1120 
1121 		/* Program GI2CCTL.I2CEn */
1122 		i2cctl = dwc2_readl(hsotg, GI2CCTL);
1123 		i2cctl &= ~GI2CCTL_I2CDEVADDR_MASK;
1124 		i2cctl |= 1 << GI2CCTL_I2CDEVADDR_SHIFT;
1125 		i2cctl &= ~GI2CCTL_I2CEN;
1126 		dwc2_writel(hsotg, i2cctl, GI2CCTL);
1127 		i2cctl |= GI2CCTL_I2CEN;
1128 		dwc2_writel(hsotg, i2cctl, GI2CCTL);
1129 	}
1130 
1131 	return retval;
1132 }
1133 
dwc2_hs_phy_init(struct dwc2_hsotg * hsotg,bool select_phy)1134 static int dwc2_hs_phy_init(struct dwc2_hsotg *hsotg, bool select_phy)
1135 {
1136 	u32 usbcfg, usbcfg_old;
1137 	int retval = 0;
1138 
1139 	if (!select_phy)
1140 		return 0;
1141 
1142 	usbcfg = dwc2_readl(hsotg, GUSBCFG);
1143 	usbcfg_old = usbcfg;
1144 
1145 	/*
1146 	 * HS PHY parameters. These parameters are preserved during soft reset
1147 	 * so only program the first time. Do a soft reset immediately after
1148 	 * setting phyif.
1149 	 */
1150 	switch (hsotg->params.phy_type) {
1151 	case DWC2_PHY_TYPE_PARAM_ULPI:
1152 		/* ULPI interface */
1153 		dev_dbg(hsotg->dev, "HS ULPI PHY selected\n");
1154 		usbcfg |= GUSBCFG_ULPI_UTMI_SEL;
1155 		usbcfg &= ~(GUSBCFG_PHYIF16 | GUSBCFG_DDRSEL);
1156 		if (hsotg->params.phy_ulpi_ddr)
1157 			usbcfg |= GUSBCFG_DDRSEL;
1158 
1159 		/* Set external VBUS indicator as needed. */
1160 		if (hsotg->params.oc_disable)
1161 			usbcfg |= (GUSBCFG_ULPI_INT_VBUS_IND |
1162 				   GUSBCFG_INDICATORPASSTHROUGH);
1163 		break;
1164 	case DWC2_PHY_TYPE_PARAM_UTMI:
1165 		/* UTMI+ interface */
1166 		dev_dbg(hsotg->dev, "HS UTMI+ PHY selected\n");
1167 		usbcfg &= ~(GUSBCFG_ULPI_UTMI_SEL | GUSBCFG_PHYIF16);
1168 		if (hsotg->params.phy_utmi_width == 16)
1169 			usbcfg |= GUSBCFG_PHYIF16;
1170 		break;
1171 	default:
1172 		dev_err(hsotg->dev, "FS PHY selected at HS!\n");
1173 		break;
1174 	}
1175 
1176 	if (usbcfg != usbcfg_old) {
1177 		dwc2_writel(hsotg, usbcfg, GUSBCFG);
1178 
1179 		/* Reset after setting the PHY parameters */
1180 		retval = dwc2_core_reset(hsotg, false);
1181 		if (retval) {
1182 			dev_err(hsotg->dev,
1183 				"%s: Reset failed, aborting", __func__);
1184 			return retval;
1185 		}
1186 	}
1187 
1188 	return retval;
1189 }
1190 
dwc2_set_turnaround_time(struct dwc2_hsotg * hsotg)1191 static void dwc2_set_turnaround_time(struct dwc2_hsotg *hsotg)
1192 {
1193 	u32 usbcfg;
1194 
1195 	if (hsotg->params.phy_type != DWC2_PHY_TYPE_PARAM_UTMI)
1196 		return;
1197 
1198 	usbcfg = dwc2_readl(hsotg, GUSBCFG);
1199 
1200 	usbcfg &= ~GUSBCFG_USBTRDTIM_MASK;
1201 	if (hsotg->params.phy_utmi_width == 16)
1202 		usbcfg |= 5 << GUSBCFG_USBTRDTIM_SHIFT;
1203 	else
1204 		usbcfg |= 9 << GUSBCFG_USBTRDTIM_SHIFT;
1205 
1206 	dwc2_writel(hsotg, usbcfg, GUSBCFG);
1207 }
1208 
dwc2_phy_init(struct dwc2_hsotg * hsotg,bool select_phy)1209 int dwc2_phy_init(struct dwc2_hsotg *hsotg, bool select_phy)
1210 {
1211 	u32 usbcfg;
1212 	int retval = 0;
1213 
1214 	if ((hsotg->params.speed == DWC2_SPEED_PARAM_FULL ||
1215 	     hsotg->params.speed == DWC2_SPEED_PARAM_LOW) &&
1216 	    hsotg->params.phy_type == DWC2_PHY_TYPE_PARAM_FS) {
1217 		/* If FS/LS mode with FS/LS PHY */
1218 		retval = dwc2_fs_phy_init(hsotg, select_phy);
1219 		if (retval)
1220 			return retval;
1221 	} else {
1222 		/* High speed PHY */
1223 		retval = dwc2_hs_phy_init(hsotg, select_phy);
1224 		if (retval)
1225 			return retval;
1226 
1227 		if (dwc2_is_device_mode(hsotg))
1228 			dwc2_set_turnaround_time(hsotg);
1229 	}
1230 
1231 	if (hsotg->hw_params.hs_phy_type == GHWCFG2_HS_PHY_TYPE_ULPI &&
1232 	    hsotg->hw_params.fs_phy_type == GHWCFG2_FS_PHY_TYPE_DEDICATED &&
1233 	    hsotg->params.ulpi_fs_ls) {
1234 		dev_dbg(hsotg->dev, "Setting ULPI FSLS\n");
1235 		usbcfg = dwc2_readl(hsotg, GUSBCFG);
1236 		usbcfg |= GUSBCFG_ULPI_FS_LS;
1237 		usbcfg |= GUSBCFG_ULPI_CLK_SUSP_M;
1238 		dwc2_writel(hsotg, usbcfg, GUSBCFG);
1239 	} else {
1240 		usbcfg = dwc2_readl(hsotg, GUSBCFG);
1241 		usbcfg &= ~GUSBCFG_ULPI_FS_LS;
1242 		usbcfg &= ~GUSBCFG_ULPI_CLK_SUSP_M;
1243 		dwc2_writel(hsotg, usbcfg, GUSBCFG);
1244 	}
1245 
1246 	return retval;
1247 }
1248 
1249 MODULE_DESCRIPTION("DESIGNWARE HS OTG Core");
1250 MODULE_AUTHOR("Synopsys, Inc.");
1251 MODULE_LICENSE("Dual BSD/GPL");
1252