xref: /linux/drivers/usb/dwc3/dwc3-qcom.c (revision 021bc4b9)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2018, The Linux Foundation. All rights reserved.
3  *
4  * Inspired by dwc3-of-simple.c
5  */
6 
7 #include <linux/acpi.h>
8 #include <linux/io.h>
9 #include <linux/of.h>
10 #include <linux/clk.h>
11 #include <linux/irq.h>
12 #include <linux/of_clk.h>
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/extcon.h>
16 #include <linux/interconnect.h>
17 #include <linux/of_platform.h>
18 #include <linux/platform_device.h>
19 #include <linux/phy/phy.h>
20 #include <linux/usb/of.h>
21 #include <linux/reset.h>
22 #include <linux/iopoll.h>
23 #include <linux/usb/hcd.h>
24 #include <linux/usb.h>
25 #include "core.h"
26 
27 /* USB QSCRATCH Hardware registers */
28 #define QSCRATCH_HS_PHY_CTRL			0x10
29 #define UTMI_OTG_VBUS_VALID			BIT(20)
30 #define SW_SESSVLD_SEL				BIT(28)
31 
32 #define QSCRATCH_SS_PHY_CTRL			0x30
33 #define LANE0_PWR_PRESENT			BIT(24)
34 
35 #define QSCRATCH_GENERAL_CFG			0x08
36 #define PIPE_UTMI_CLK_SEL			BIT(0)
37 #define PIPE3_PHYSTATUS_SW			BIT(3)
38 #define PIPE_UTMI_CLK_DIS			BIT(8)
39 
40 #define PWR_EVNT_IRQ_STAT_REG			0x58
41 #define PWR_EVNT_LPM_IN_L2_MASK			BIT(4)
42 #define PWR_EVNT_LPM_OUT_L2_MASK		BIT(5)
43 
44 #define SDM845_QSCRATCH_BASE_OFFSET		0xf8800
45 #define SDM845_QSCRATCH_SIZE			0x400
46 #define SDM845_DWC3_CORE_SIZE			0xcd00
47 
48 /* Interconnect path bandwidths in MBps */
49 #define USB_MEMORY_AVG_HS_BW MBps_to_icc(240)
50 #define USB_MEMORY_PEAK_HS_BW MBps_to_icc(700)
51 #define USB_MEMORY_AVG_SS_BW  MBps_to_icc(1000)
52 #define USB_MEMORY_PEAK_SS_BW MBps_to_icc(2500)
53 #define APPS_USB_AVG_BW 0
54 #define APPS_USB_PEAK_BW MBps_to_icc(40)
55 
56 struct dwc3_acpi_pdata {
57 	u32			qscratch_base_offset;
58 	u32			qscratch_base_size;
59 	u32			dwc3_core_base_size;
60 	int			qusb2_phy_irq_index;
61 	int			dp_hs_phy_irq_index;
62 	int			dm_hs_phy_irq_index;
63 	int			ss_phy_irq_index;
64 	bool			is_urs;
65 };
66 
67 struct dwc3_qcom {
68 	struct device		*dev;
69 	void __iomem		*qscratch_base;
70 	struct platform_device	*dwc3;
71 	struct platform_device	*urs_usb;
72 	struct clk		**clks;
73 	int			num_clocks;
74 	struct reset_control	*resets;
75 
76 	int			qusb2_phy_irq;
77 	int			dp_hs_phy_irq;
78 	int			dm_hs_phy_irq;
79 	int			ss_phy_irq;
80 	enum usb_device_speed	usb2_speed;
81 
82 	struct extcon_dev	*edev;
83 	struct extcon_dev	*host_edev;
84 	struct notifier_block	vbus_nb;
85 	struct notifier_block	host_nb;
86 
87 	const struct dwc3_acpi_pdata *acpi_pdata;
88 
89 	enum usb_dr_mode	mode;
90 	bool			is_suspended;
91 	bool			pm_suspended;
92 	struct icc_path		*icc_path_ddr;
93 	struct icc_path		*icc_path_apps;
94 };
95 
96 static inline void dwc3_qcom_setbits(void __iomem *base, u32 offset, u32 val)
97 {
98 	u32 reg;
99 
100 	reg = readl(base + offset);
101 	reg |= val;
102 	writel(reg, base + offset);
103 
104 	/* ensure that above write is through */
105 	readl(base + offset);
106 }
107 
108 static inline void dwc3_qcom_clrbits(void __iomem *base, u32 offset, u32 val)
109 {
110 	u32 reg;
111 
112 	reg = readl(base + offset);
113 	reg &= ~val;
114 	writel(reg, base + offset);
115 
116 	/* ensure that above write is through */
117 	readl(base + offset);
118 }
119 
120 static void dwc3_qcom_vbus_override_enable(struct dwc3_qcom *qcom, bool enable)
121 {
122 	if (enable) {
123 		dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_SS_PHY_CTRL,
124 				  LANE0_PWR_PRESENT);
125 		dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_HS_PHY_CTRL,
126 				  UTMI_OTG_VBUS_VALID | SW_SESSVLD_SEL);
127 	} else {
128 		dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_SS_PHY_CTRL,
129 				  LANE0_PWR_PRESENT);
130 		dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_HS_PHY_CTRL,
131 				  UTMI_OTG_VBUS_VALID | SW_SESSVLD_SEL);
132 	}
133 }
134 
135 static int dwc3_qcom_vbus_notifier(struct notifier_block *nb,
136 				   unsigned long event, void *ptr)
137 {
138 	struct dwc3_qcom *qcom = container_of(nb, struct dwc3_qcom, vbus_nb);
139 
140 	/* enable vbus override for device mode */
141 	dwc3_qcom_vbus_override_enable(qcom, event);
142 	qcom->mode = event ? USB_DR_MODE_PERIPHERAL : USB_DR_MODE_HOST;
143 
144 	return NOTIFY_DONE;
145 }
146 
147 static int dwc3_qcom_host_notifier(struct notifier_block *nb,
148 				   unsigned long event, void *ptr)
149 {
150 	struct dwc3_qcom *qcom = container_of(nb, struct dwc3_qcom, host_nb);
151 
152 	/* disable vbus override in host mode */
153 	dwc3_qcom_vbus_override_enable(qcom, !event);
154 	qcom->mode = event ? USB_DR_MODE_HOST : USB_DR_MODE_PERIPHERAL;
155 
156 	return NOTIFY_DONE;
157 }
158 
159 static int dwc3_qcom_register_extcon(struct dwc3_qcom *qcom)
160 {
161 	struct device		*dev = qcom->dev;
162 	struct extcon_dev	*host_edev;
163 	int			ret;
164 
165 	if (!of_property_read_bool(dev->of_node, "extcon"))
166 		return 0;
167 
168 	qcom->edev = extcon_get_edev_by_phandle(dev, 0);
169 	if (IS_ERR(qcom->edev))
170 		return dev_err_probe(dev, PTR_ERR(qcom->edev),
171 				     "Failed to get extcon\n");
172 
173 	qcom->vbus_nb.notifier_call = dwc3_qcom_vbus_notifier;
174 
175 	qcom->host_edev = extcon_get_edev_by_phandle(dev, 1);
176 	if (IS_ERR(qcom->host_edev))
177 		qcom->host_edev = NULL;
178 
179 	ret = devm_extcon_register_notifier(dev, qcom->edev, EXTCON_USB,
180 					    &qcom->vbus_nb);
181 	if (ret < 0) {
182 		dev_err(dev, "VBUS notifier register failed\n");
183 		return ret;
184 	}
185 
186 	if (qcom->host_edev)
187 		host_edev = qcom->host_edev;
188 	else
189 		host_edev = qcom->edev;
190 
191 	qcom->host_nb.notifier_call = dwc3_qcom_host_notifier;
192 	ret = devm_extcon_register_notifier(dev, host_edev, EXTCON_USB_HOST,
193 					    &qcom->host_nb);
194 	if (ret < 0) {
195 		dev_err(dev, "Host notifier register failed\n");
196 		return ret;
197 	}
198 
199 	/* Update initial VBUS override based on extcon state */
200 	if (extcon_get_state(qcom->edev, EXTCON_USB) ||
201 	    !extcon_get_state(host_edev, EXTCON_USB_HOST))
202 		dwc3_qcom_vbus_notifier(&qcom->vbus_nb, true, qcom->edev);
203 	else
204 		dwc3_qcom_vbus_notifier(&qcom->vbus_nb, false, qcom->edev);
205 
206 	return 0;
207 }
208 
209 static int dwc3_qcom_interconnect_enable(struct dwc3_qcom *qcom)
210 {
211 	int ret;
212 
213 	ret = icc_enable(qcom->icc_path_ddr);
214 	if (ret)
215 		return ret;
216 
217 	ret = icc_enable(qcom->icc_path_apps);
218 	if (ret)
219 		icc_disable(qcom->icc_path_ddr);
220 
221 	return ret;
222 }
223 
224 static int dwc3_qcom_interconnect_disable(struct dwc3_qcom *qcom)
225 {
226 	int ret;
227 
228 	ret = icc_disable(qcom->icc_path_ddr);
229 	if (ret)
230 		return ret;
231 
232 	ret = icc_disable(qcom->icc_path_apps);
233 	if (ret)
234 		icc_enable(qcom->icc_path_ddr);
235 
236 	return ret;
237 }
238 
239 /**
240  * dwc3_qcom_interconnect_init() - Get interconnect path handles
241  * and set bandwidth.
242  * @qcom:			Pointer to the concerned usb core.
243  *
244  */
245 static int dwc3_qcom_interconnect_init(struct dwc3_qcom *qcom)
246 {
247 	enum usb_device_speed max_speed;
248 	struct device *dev = qcom->dev;
249 	int ret;
250 
251 	if (has_acpi_companion(dev))
252 		return 0;
253 
254 	qcom->icc_path_ddr = of_icc_get(dev, "usb-ddr");
255 	if (IS_ERR(qcom->icc_path_ddr)) {
256 		return dev_err_probe(dev, PTR_ERR(qcom->icc_path_ddr),
257 				     "failed to get usb-ddr path\n");
258 	}
259 
260 	qcom->icc_path_apps = of_icc_get(dev, "apps-usb");
261 	if (IS_ERR(qcom->icc_path_apps)) {
262 		ret = dev_err_probe(dev, PTR_ERR(qcom->icc_path_apps),
263 				    "failed to get apps-usb path\n");
264 		goto put_path_ddr;
265 	}
266 
267 	max_speed = usb_get_maximum_speed(&qcom->dwc3->dev);
268 	if (max_speed >= USB_SPEED_SUPER || max_speed == USB_SPEED_UNKNOWN) {
269 		ret = icc_set_bw(qcom->icc_path_ddr,
270 				USB_MEMORY_AVG_SS_BW, USB_MEMORY_PEAK_SS_BW);
271 	} else {
272 		ret = icc_set_bw(qcom->icc_path_ddr,
273 				USB_MEMORY_AVG_HS_BW, USB_MEMORY_PEAK_HS_BW);
274 	}
275 	if (ret) {
276 		dev_err(dev, "failed to set bandwidth for usb-ddr path: %d\n", ret);
277 		goto put_path_apps;
278 	}
279 
280 	ret = icc_set_bw(qcom->icc_path_apps, APPS_USB_AVG_BW, APPS_USB_PEAK_BW);
281 	if (ret) {
282 		dev_err(dev, "failed to set bandwidth for apps-usb path: %d\n", ret);
283 		goto put_path_apps;
284 	}
285 
286 	return 0;
287 
288 put_path_apps:
289 	icc_put(qcom->icc_path_apps);
290 put_path_ddr:
291 	icc_put(qcom->icc_path_ddr);
292 	return ret;
293 }
294 
295 /**
296  * dwc3_qcom_interconnect_exit() - Release interconnect path handles
297  * @qcom:			Pointer to the concerned usb core.
298  *
299  * This function is used to release interconnect path handle.
300  */
301 static void dwc3_qcom_interconnect_exit(struct dwc3_qcom *qcom)
302 {
303 	icc_put(qcom->icc_path_ddr);
304 	icc_put(qcom->icc_path_apps);
305 }
306 
307 /* Only usable in contexts where the role can not change. */
308 static bool dwc3_qcom_is_host(struct dwc3_qcom *qcom)
309 {
310 	struct dwc3 *dwc;
311 
312 	/*
313 	 * FIXME: Fix this layering violation.
314 	 */
315 	dwc = platform_get_drvdata(qcom->dwc3);
316 
317 	/* Core driver may not have probed yet. */
318 	if (!dwc)
319 		return false;
320 
321 	return dwc->xhci;
322 }
323 
324 static enum usb_device_speed dwc3_qcom_read_usb2_speed(struct dwc3_qcom *qcom)
325 {
326 	struct dwc3 *dwc = platform_get_drvdata(qcom->dwc3);
327 	struct usb_device *udev;
328 	struct usb_hcd __maybe_unused *hcd;
329 
330 	/*
331 	 * FIXME: Fix this layering violation.
332 	 */
333 	hcd = platform_get_drvdata(dwc->xhci);
334 
335 	/*
336 	 * It is possible to query the speed of all children of
337 	 * USB2.0 root hub via usb_hub_for_each_child(). DWC3 code
338 	 * currently supports only 1 port per controller. So
339 	 * this is sufficient.
340 	 */
341 #ifdef CONFIG_USB
342 	udev = usb_hub_find_child(hcd->self.root_hub, 1);
343 #else
344 	udev = NULL;
345 #endif
346 	if (!udev)
347 		return USB_SPEED_UNKNOWN;
348 
349 	return udev->speed;
350 }
351 
352 static void dwc3_qcom_enable_wakeup_irq(int irq, unsigned int polarity)
353 {
354 	if (!irq)
355 		return;
356 
357 	if (polarity)
358 		irq_set_irq_type(irq, polarity);
359 
360 	enable_irq(irq);
361 	enable_irq_wake(irq);
362 }
363 
364 static void dwc3_qcom_disable_wakeup_irq(int irq)
365 {
366 	if (!irq)
367 		return;
368 
369 	disable_irq_wake(irq);
370 	disable_irq_nosync(irq);
371 }
372 
373 static void dwc3_qcom_disable_interrupts(struct dwc3_qcom *qcom)
374 {
375 	dwc3_qcom_disable_wakeup_irq(qcom->qusb2_phy_irq);
376 
377 	if (qcom->usb2_speed == USB_SPEED_LOW) {
378 		dwc3_qcom_disable_wakeup_irq(qcom->dm_hs_phy_irq);
379 	} else if ((qcom->usb2_speed == USB_SPEED_HIGH) ||
380 			(qcom->usb2_speed == USB_SPEED_FULL)) {
381 		dwc3_qcom_disable_wakeup_irq(qcom->dp_hs_phy_irq);
382 	} else {
383 		dwc3_qcom_disable_wakeup_irq(qcom->dp_hs_phy_irq);
384 		dwc3_qcom_disable_wakeup_irq(qcom->dm_hs_phy_irq);
385 	}
386 
387 	dwc3_qcom_disable_wakeup_irq(qcom->ss_phy_irq);
388 }
389 
390 static void dwc3_qcom_enable_interrupts(struct dwc3_qcom *qcom)
391 {
392 	dwc3_qcom_enable_wakeup_irq(qcom->qusb2_phy_irq, 0);
393 
394 	/*
395 	 * Configure DP/DM line interrupts based on the USB2 device attached to
396 	 * the root hub port. When HS/FS device is connected, configure the DP line
397 	 * as falling edge to detect both disconnect and remote wakeup scenarios. When
398 	 * LS device is connected, configure DM line as falling edge to detect both
399 	 * disconnect and remote wakeup. When no device is connected, configure both
400 	 * DP and DM lines as rising edge to detect HS/HS/LS device connect scenario.
401 	 */
402 
403 	if (qcom->usb2_speed == USB_SPEED_LOW) {
404 		dwc3_qcom_enable_wakeup_irq(qcom->dm_hs_phy_irq,
405 						IRQ_TYPE_EDGE_FALLING);
406 	} else if ((qcom->usb2_speed == USB_SPEED_HIGH) ||
407 			(qcom->usb2_speed == USB_SPEED_FULL)) {
408 		dwc3_qcom_enable_wakeup_irq(qcom->dp_hs_phy_irq,
409 						IRQ_TYPE_EDGE_FALLING);
410 	} else {
411 		dwc3_qcom_enable_wakeup_irq(qcom->dp_hs_phy_irq,
412 						IRQ_TYPE_EDGE_RISING);
413 		dwc3_qcom_enable_wakeup_irq(qcom->dm_hs_phy_irq,
414 						IRQ_TYPE_EDGE_RISING);
415 	}
416 
417 	dwc3_qcom_enable_wakeup_irq(qcom->ss_phy_irq, 0);
418 }
419 
420 static int dwc3_qcom_suspend(struct dwc3_qcom *qcom, bool wakeup)
421 {
422 	u32 val;
423 	int i, ret;
424 
425 	if (qcom->is_suspended)
426 		return 0;
427 
428 	val = readl(qcom->qscratch_base + PWR_EVNT_IRQ_STAT_REG);
429 	if (!(val & PWR_EVNT_LPM_IN_L2_MASK))
430 		dev_err(qcom->dev, "HS-PHY not in L2\n");
431 
432 	for (i = qcom->num_clocks - 1; i >= 0; i--)
433 		clk_disable_unprepare(qcom->clks[i]);
434 
435 	ret = dwc3_qcom_interconnect_disable(qcom);
436 	if (ret)
437 		dev_warn(qcom->dev, "failed to disable interconnect: %d\n", ret);
438 
439 	/*
440 	 * The role is stable during suspend as role switching is done from a
441 	 * freezable workqueue.
442 	 */
443 	if (dwc3_qcom_is_host(qcom) && wakeup) {
444 		qcom->usb2_speed = dwc3_qcom_read_usb2_speed(qcom);
445 		dwc3_qcom_enable_interrupts(qcom);
446 	}
447 
448 	qcom->is_suspended = true;
449 
450 	return 0;
451 }
452 
453 static int dwc3_qcom_resume(struct dwc3_qcom *qcom, bool wakeup)
454 {
455 	int ret;
456 	int i;
457 
458 	if (!qcom->is_suspended)
459 		return 0;
460 
461 	if (dwc3_qcom_is_host(qcom) && wakeup)
462 		dwc3_qcom_disable_interrupts(qcom);
463 
464 	for (i = 0; i < qcom->num_clocks; i++) {
465 		ret = clk_prepare_enable(qcom->clks[i]);
466 		if (ret < 0) {
467 			while (--i >= 0)
468 				clk_disable_unprepare(qcom->clks[i]);
469 			return ret;
470 		}
471 	}
472 
473 	ret = dwc3_qcom_interconnect_enable(qcom);
474 	if (ret)
475 		dev_warn(qcom->dev, "failed to enable interconnect: %d\n", ret);
476 
477 	/* Clear existing events from PHY related to L2 in/out */
478 	dwc3_qcom_setbits(qcom->qscratch_base, PWR_EVNT_IRQ_STAT_REG,
479 			  PWR_EVNT_LPM_IN_L2_MASK | PWR_EVNT_LPM_OUT_L2_MASK);
480 
481 	qcom->is_suspended = false;
482 
483 	return 0;
484 }
485 
486 static irqreturn_t qcom_dwc3_resume_irq(int irq, void *data)
487 {
488 	struct dwc3_qcom *qcom = data;
489 	struct dwc3	*dwc = platform_get_drvdata(qcom->dwc3);
490 
491 	/* If pm_suspended then let pm_resume take care of resuming h/w */
492 	if (qcom->pm_suspended)
493 		return IRQ_HANDLED;
494 
495 	/*
496 	 * This is safe as role switching is done from a freezable workqueue
497 	 * and the wakeup interrupts are disabled as part of resume.
498 	 */
499 	if (dwc3_qcom_is_host(qcom))
500 		pm_runtime_resume(&dwc->xhci->dev);
501 
502 	return IRQ_HANDLED;
503 }
504 
505 static void dwc3_qcom_select_utmi_clk(struct dwc3_qcom *qcom)
506 {
507 	/* Configure dwc3 to use UTMI clock as PIPE clock not present */
508 	dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG,
509 			  PIPE_UTMI_CLK_DIS);
510 
511 	usleep_range(100, 1000);
512 
513 	dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG,
514 			  PIPE_UTMI_CLK_SEL | PIPE3_PHYSTATUS_SW);
515 
516 	usleep_range(100, 1000);
517 
518 	dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG,
519 			  PIPE_UTMI_CLK_DIS);
520 }
521 
522 static int dwc3_qcom_get_irq(struct platform_device *pdev,
523 			     const char *name, int num)
524 {
525 	struct dwc3_qcom *qcom = platform_get_drvdata(pdev);
526 	struct platform_device *pdev_irq = qcom->urs_usb ? qcom->urs_usb : pdev;
527 	struct device_node *np = pdev->dev.of_node;
528 	int ret;
529 
530 	if (np)
531 		ret = platform_get_irq_byname_optional(pdev_irq, name);
532 	else
533 		ret = platform_get_irq_optional(pdev_irq, num);
534 
535 	return ret;
536 }
537 
538 static int dwc3_qcom_setup_irq(struct platform_device *pdev)
539 {
540 	struct dwc3_qcom *qcom = platform_get_drvdata(pdev);
541 	const struct dwc3_acpi_pdata *pdata = qcom->acpi_pdata;
542 	int irq;
543 	int ret;
544 
545 	irq = dwc3_qcom_get_irq(pdev, "qusb2_phy",
546 				pdata ? pdata->qusb2_phy_irq_index : -1);
547 	if (irq > 0) {
548 		/* Keep wakeup interrupts disabled until suspend */
549 		ret = devm_request_threaded_irq(qcom->dev, irq, NULL,
550 					qcom_dwc3_resume_irq,
551 					IRQF_ONESHOT | IRQF_NO_AUTOEN,
552 					"qcom_dwc3 QUSB2", qcom);
553 		if (ret) {
554 			dev_err(qcom->dev, "qusb2_phy_irq failed: %d\n", ret);
555 			return ret;
556 		}
557 		qcom->qusb2_phy_irq = irq;
558 	}
559 
560 	irq = dwc3_qcom_get_irq(pdev, "dp_hs_phy_irq",
561 				pdata ? pdata->dp_hs_phy_irq_index : -1);
562 	if (irq > 0) {
563 		ret = devm_request_threaded_irq(qcom->dev, irq, NULL,
564 					qcom_dwc3_resume_irq,
565 					IRQF_ONESHOT | IRQF_NO_AUTOEN,
566 					"qcom_dwc3 DP_HS", qcom);
567 		if (ret) {
568 			dev_err(qcom->dev, "dp_hs_phy_irq failed: %d\n", ret);
569 			return ret;
570 		}
571 		qcom->dp_hs_phy_irq = irq;
572 	}
573 
574 	irq = dwc3_qcom_get_irq(pdev, "dm_hs_phy_irq",
575 				pdata ? pdata->dm_hs_phy_irq_index : -1);
576 	if (irq > 0) {
577 		ret = devm_request_threaded_irq(qcom->dev, irq, NULL,
578 					qcom_dwc3_resume_irq,
579 					IRQF_ONESHOT | IRQF_NO_AUTOEN,
580 					"qcom_dwc3 DM_HS", qcom);
581 		if (ret) {
582 			dev_err(qcom->dev, "dm_hs_phy_irq failed: %d\n", ret);
583 			return ret;
584 		}
585 		qcom->dm_hs_phy_irq = irq;
586 	}
587 
588 	irq = dwc3_qcom_get_irq(pdev, "ss_phy_irq",
589 				pdata ? pdata->ss_phy_irq_index : -1);
590 	if (irq > 0) {
591 		ret = devm_request_threaded_irq(qcom->dev, irq, NULL,
592 					qcom_dwc3_resume_irq,
593 					IRQF_ONESHOT | IRQF_NO_AUTOEN,
594 					"qcom_dwc3 SS", qcom);
595 		if (ret) {
596 			dev_err(qcom->dev, "ss_phy_irq failed: %d\n", ret);
597 			return ret;
598 		}
599 		qcom->ss_phy_irq = irq;
600 	}
601 
602 	return 0;
603 }
604 
605 static int dwc3_qcom_clk_init(struct dwc3_qcom *qcom, int count)
606 {
607 	struct device		*dev = qcom->dev;
608 	struct device_node	*np = dev->of_node;
609 	int			i;
610 
611 	if (!np || !count)
612 		return 0;
613 
614 	if (count < 0)
615 		return count;
616 
617 	qcom->num_clocks = count;
618 
619 	qcom->clks = devm_kcalloc(dev, qcom->num_clocks,
620 				  sizeof(struct clk *), GFP_KERNEL);
621 	if (!qcom->clks)
622 		return -ENOMEM;
623 
624 	for (i = 0; i < qcom->num_clocks; i++) {
625 		struct clk	*clk;
626 		int		ret;
627 
628 		clk = of_clk_get(np, i);
629 		if (IS_ERR(clk)) {
630 			while (--i >= 0)
631 				clk_put(qcom->clks[i]);
632 			return PTR_ERR(clk);
633 		}
634 
635 		ret = clk_prepare_enable(clk);
636 		if (ret < 0) {
637 			while (--i >= 0) {
638 				clk_disable_unprepare(qcom->clks[i]);
639 				clk_put(qcom->clks[i]);
640 			}
641 			clk_put(clk);
642 
643 			return ret;
644 		}
645 
646 		qcom->clks[i] = clk;
647 	}
648 
649 	return 0;
650 }
651 
652 static const struct property_entry dwc3_qcom_acpi_properties[] = {
653 	PROPERTY_ENTRY_STRING("dr_mode", "host"),
654 	{}
655 };
656 
657 static const struct software_node dwc3_qcom_swnode = {
658 	.properties = dwc3_qcom_acpi_properties,
659 };
660 
661 static int dwc3_qcom_acpi_register_core(struct platform_device *pdev)
662 {
663 	struct dwc3_qcom	*qcom = platform_get_drvdata(pdev);
664 	struct device		*dev = &pdev->dev;
665 	struct resource		*res, *child_res = NULL;
666 	struct platform_device	*pdev_irq = qcom->urs_usb ? qcom->urs_usb :
667 							    pdev;
668 	int			irq;
669 	int			ret;
670 
671 	qcom->dwc3 = platform_device_alloc("dwc3", PLATFORM_DEVID_AUTO);
672 	if (!qcom->dwc3)
673 		return -ENOMEM;
674 
675 	qcom->dwc3->dev.parent = dev;
676 	qcom->dwc3->dev.type = dev->type;
677 	qcom->dwc3->dev.dma_mask = dev->dma_mask;
678 	qcom->dwc3->dev.dma_parms = dev->dma_parms;
679 	qcom->dwc3->dev.coherent_dma_mask = dev->coherent_dma_mask;
680 
681 	child_res = kcalloc(2, sizeof(*child_res), GFP_KERNEL);
682 	if (!child_res) {
683 		platform_device_put(qcom->dwc3);
684 		return -ENOMEM;
685 	}
686 
687 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
688 	if (!res) {
689 		dev_err(&pdev->dev, "failed to get memory resource\n");
690 		ret = -ENODEV;
691 		goto out;
692 	}
693 
694 	child_res[0].flags = res->flags;
695 	child_res[0].start = res->start;
696 	child_res[0].end = child_res[0].start +
697 		qcom->acpi_pdata->dwc3_core_base_size;
698 
699 	irq = platform_get_irq(pdev_irq, 0);
700 	if (irq < 0) {
701 		ret = irq;
702 		goto out;
703 	}
704 	child_res[1].flags = IORESOURCE_IRQ;
705 	child_res[1].start = child_res[1].end = irq;
706 
707 	ret = platform_device_add_resources(qcom->dwc3, child_res, 2);
708 	if (ret) {
709 		dev_err(&pdev->dev, "failed to add resources\n");
710 		goto out;
711 	}
712 
713 	ret = device_add_software_node(&qcom->dwc3->dev, &dwc3_qcom_swnode);
714 	if (ret < 0) {
715 		dev_err(&pdev->dev, "failed to add properties\n");
716 		goto out;
717 	}
718 
719 	ret = platform_device_add(qcom->dwc3);
720 	if (ret) {
721 		dev_err(&pdev->dev, "failed to add device\n");
722 		device_remove_software_node(&qcom->dwc3->dev);
723 		goto out;
724 	}
725 	kfree(child_res);
726 	return 0;
727 
728 out:
729 	platform_device_put(qcom->dwc3);
730 	kfree(child_res);
731 	return ret;
732 }
733 
734 static int dwc3_qcom_of_register_core(struct platform_device *pdev)
735 {
736 	struct dwc3_qcom	*qcom = platform_get_drvdata(pdev);
737 	struct device_node	*np = pdev->dev.of_node, *dwc3_np;
738 	struct device		*dev = &pdev->dev;
739 	int			ret;
740 
741 	dwc3_np = of_get_compatible_child(np, "snps,dwc3");
742 	if (!dwc3_np) {
743 		dev_err(dev, "failed to find dwc3 core child\n");
744 		return -ENODEV;
745 	}
746 
747 	ret = of_platform_populate(np, NULL, NULL, dev);
748 	if (ret) {
749 		dev_err(dev, "failed to register dwc3 core - %d\n", ret);
750 		goto node_put;
751 	}
752 
753 	qcom->dwc3 = of_find_device_by_node(dwc3_np);
754 	if (!qcom->dwc3) {
755 		ret = -ENODEV;
756 		dev_err(dev, "failed to get dwc3 platform device\n");
757 		of_platform_depopulate(dev);
758 	}
759 
760 node_put:
761 	of_node_put(dwc3_np);
762 
763 	return ret;
764 }
765 
766 static struct platform_device *dwc3_qcom_create_urs_usb_platdev(struct device *dev)
767 {
768 	struct platform_device *urs_usb = NULL;
769 	struct fwnode_handle *fwh;
770 	struct acpi_device *adev;
771 	char name[8];
772 	int ret;
773 	int id;
774 
775 	/* Figure out device id */
776 	ret = sscanf(fwnode_get_name(dev->fwnode), "URS%d", &id);
777 	if (!ret)
778 		return NULL;
779 
780 	/* Find the child using name */
781 	snprintf(name, sizeof(name), "USB%d", id);
782 	fwh = fwnode_get_named_child_node(dev->fwnode, name);
783 	if (!fwh)
784 		return NULL;
785 
786 	adev = to_acpi_device_node(fwh);
787 	if (!adev)
788 		goto err_put_handle;
789 
790 	urs_usb = acpi_create_platform_device(adev, NULL);
791 	if (IS_ERR_OR_NULL(urs_usb))
792 		goto err_put_handle;
793 
794 	return urs_usb;
795 
796 err_put_handle:
797 	fwnode_handle_put(fwh);
798 
799 	return urs_usb;
800 }
801 
802 static void dwc3_qcom_destroy_urs_usb_platdev(struct platform_device *urs_usb)
803 {
804 	struct fwnode_handle *fwh = urs_usb->dev.fwnode;
805 
806 	platform_device_unregister(urs_usb);
807 	fwnode_handle_put(fwh);
808 }
809 
810 static int dwc3_qcom_probe(struct platform_device *pdev)
811 {
812 	struct device_node	*np = pdev->dev.of_node;
813 	struct device		*dev = &pdev->dev;
814 	struct dwc3_qcom	*qcom;
815 	struct resource		*res, *parent_res = NULL;
816 	struct resource		local_res;
817 	int			ret, i;
818 	bool			ignore_pipe_clk;
819 	bool			wakeup_source;
820 
821 	qcom = devm_kzalloc(&pdev->dev, sizeof(*qcom), GFP_KERNEL);
822 	if (!qcom)
823 		return -ENOMEM;
824 
825 	platform_set_drvdata(pdev, qcom);
826 	qcom->dev = &pdev->dev;
827 
828 	if (has_acpi_companion(dev)) {
829 		qcom->acpi_pdata = acpi_device_get_match_data(dev);
830 		if (!qcom->acpi_pdata) {
831 			dev_err(&pdev->dev, "no supporting ACPI device data\n");
832 			return -EINVAL;
833 		}
834 	}
835 
836 	qcom->resets = devm_reset_control_array_get_optional_exclusive(dev);
837 	if (IS_ERR(qcom->resets)) {
838 		return dev_err_probe(&pdev->dev, PTR_ERR(qcom->resets),
839 				     "failed to get resets\n");
840 	}
841 
842 	ret = reset_control_assert(qcom->resets);
843 	if (ret) {
844 		dev_err(&pdev->dev, "failed to assert resets, err=%d\n", ret);
845 		return ret;
846 	}
847 
848 	usleep_range(10, 1000);
849 
850 	ret = reset_control_deassert(qcom->resets);
851 	if (ret) {
852 		dev_err(&pdev->dev, "failed to deassert resets, err=%d\n", ret);
853 		goto reset_assert;
854 	}
855 
856 	ret = dwc3_qcom_clk_init(qcom, of_clk_get_parent_count(np));
857 	if (ret) {
858 		dev_err_probe(dev, ret, "failed to get clocks\n");
859 		goto reset_assert;
860 	}
861 
862 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
863 
864 	if (np) {
865 		parent_res = res;
866 	} else {
867 		memcpy(&local_res, res, sizeof(struct resource));
868 		parent_res = &local_res;
869 
870 		parent_res->start = res->start +
871 			qcom->acpi_pdata->qscratch_base_offset;
872 		parent_res->end = parent_res->start +
873 			qcom->acpi_pdata->qscratch_base_size;
874 
875 		if (qcom->acpi_pdata->is_urs) {
876 			qcom->urs_usb = dwc3_qcom_create_urs_usb_platdev(dev);
877 			if (IS_ERR_OR_NULL(qcom->urs_usb)) {
878 				dev_err(dev, "failed to create URS USB platdev\n");
879 				if (!qcom->urs_usb)
880 					ret = -ENODEV;
881 				else
882 					ret = PTR_ERR(qcom->urs_usb);
883 				goto clk_disable;
884 			}
885 		}
886 	}
887 
888 	qcom->qscratch_base = devm_ioremap_resource(dev, parent_res);
889 	if (IS_ERR(qcom->qscratch_base)) {
890 		ret = PTR_ERR(qcom->qscratch_base);
891 		goto free_urs;
892 	}
893 
894 	ret = dwc3_qcom_setup_irq(pdev);
895 	if (ret) {
896 		dev_err(dev, "failed to setup IRQs, err=%d\n", ret);
897 		goto free_urs;
898 	}
899 
900 	/*
901 	 * Disable pipe_clk requirement if specified. Used when dwc3
902 	 * operates without SSPHY and only HS/FS/LS modes are supported.
903 	 */
904 	ignore_pipe_clk = device_property_read_bool(dev,
905 				"qcom,select-utmi-as-pipe-clk");
906 	if (ignore_pipe_clk)
907 		dwc3_qcom_select_utmi_clk(qcom);
908 
909 	if (np)
910 		ret = dwc3_qcom_of_register_core(pdev);
911 	else
912 		ret = dwc3_qcom_acpi_register_core(pdev);
913 
914 	if (ret) {
915 		dev_err(dev, "failed to register DWC3 Core, err=%d\n", ret);
916 		goto free_urs;
917 	}
918 
919 	ret = dwc3_qcom_interconnect_init(qcom);
920 	if (ret)
921 		goto depopulate;
922 
923 	qcom->mode = usb_get_dr_mode(&qcom->dwc3->dev);
924 
925 	/* enable vbus override for device mode */
926 	if (qcom->mode != USB_DR_MODE_HOST)
927 		dwc3_qcom_vbus_override_enable(qcom, true);
928 
929 	/* register extcon to override sw_vbus on Vbus change later */
930 	ret = dwc3_qcom_register_extcon(qcom);
931 	if (ret)
932 		goto interconnect_exit;
933 
934 	wakeup_source = of_property_read_bool(dev->of_node, "wakeup-source");
935 	device_init_wakeup(&pdev->dev, wakeup_source);
936 	device_init_wakeup(&qcom->dwc3->dev, wakeup_source);
937 
938 	qcom->is_suspended = false;
939 	pm_runtime_set_active(dev);
940 	pm_runtime_enable(dev);
941 	pm_runtime_forbid(dev);
942 
943 	return 0;
944 
945 interconnect_exit:
946 	dwc3_qcom_interconnect_exit(qcom);
947 depopulate:
948 	if (np) {
949 		of_platform_depopulate(&pdev->dev);
950 	} else {
951 		device_remove_software_node(&qcom->dwc3->dev);
952 		platform_device_del(qcom->dwc3);
953 	}
954 	platform_device_put(qcom->dwc3);
955 free_urs:
956 	if (qcom->urs_usb)
957 		dwc3_qcom_destroy_urs_usb_platdev(qcom->urs_usb);
958 clk_disable:
959 	for (i = qcom->num_clocks - 1; i >= 0; i--) {
960 		clk_disable_unprepare(qcom->clks[i]);
961 		clk_put(qcom->clks[i]);
962 	}
963 reset_assert:
964 	reset_control_assert(qcom->resets);
965 
966 	return ret;
967 }
968 
969 static void dwc3_qcom_remove(struct platform_device *pdev)
970 {
971 	struct dwc3_qcom *qcom = platform_get_drvdata(pdev);
972 	struct device_node *np = pdev->dev.of_node;
973 	struct device *dev = &pdev->dev;
974 	int i;
975 
976 	if (np) {
977 		of_platform_depopulate(&pdev->dev);
978 	} else {
979 		device_remove_software_node(&qcom->dwc3->dev);
980 		platform_device_del(qcom->dwc3);
981 	}
982 	platform_device_put(qcom->dwc3);
983 
984 	if (qcom->urs_usb)
985 		dwc3_qcom_destroy_urs_usb_platdev(qcom->urs_usb);
986 
987 	for (i = qcom->num_clocks - 1; i >= 0; i--) {
988 		clk_disable_unprepare(qcom->clks[i]);
989 		clk_put(qcom->clks[i]);
990 	}
991 	qcom->num_clocks = 0;
992 
993 	dwc3_qcom_interconnect_exit(qcom);
994 	reset_control_assert(qcom->resets);
995 
996 	pm_runtime_allow(dev);
997 	pm_runtime_disable(dev);
998 }
999 
1000 static int __maybe_unused dwc3_qcom_pm_suspend(struct device *dev)
1001 {
1002 	struct dwc3_qcom *qcom = dev_get_drvdata(dev);
1003 	bool wakeup = device_may_wakeup(dev);
1004 	int ret;
1005 
1006 	ret = dwc3_qcom_suspend(qcom, wakeup);
1007 	if (ret)
1008 		return ret;
1009 
1010 	qcom->pm_suspended = true;
1011 
1012 	return 0;
1013 }
1014 
1015 static int __maybe_unused dwc3_qcom_pm_resume(struct device *dev)
1016 {
1017 	struct dwc3_qcom *qcom = dev_get_drvdata(dev);
1018 	bool wakeup = device_may_wakeup(dev);
1019 	int ret;
1020 
1021 	ret = dwc3_qcom_resume(qcom, wakeup);
1022 	if (ret)
1023 		return ret;
1024 
1025 	qcom->pm_suspended = false;
1026 
1027 	return 0;
1028 }
1029 
1030 static int __maybe_unused dwc3_qcom_runtime_suspend(struct device *dev)
1031 {
1032 	struct dwc3_qcom *qcom = dev_get_drvdata(dev);
1033 
1034 	return dwc3_qcom_suspend(qcom, true);
1035 }
1036 
1037 static int __maybe_unused dwc3_qcom_runtime_resume(struct device *dev)
1038 {
1039 	struct dwc3_qcom *qcom = dev_get_drvdata(dev);
1040 
1041 	return dwc3_qcom_resume(qcom, true);
1042 }
1043 
1044 static const struct dev_pm_ops dwc3_qcom_dev_pm_ops = {
1045 	SET_SYSTEM_SLEEP_PM_OPS(dwc3_qcom_pm_suspend, dwc3_qcom_pm_resume)
1046 	SET_RUNTIME_PM_OPS(dwc3_qcom_runtime_suspend, dwc3_qcom_runtime_resume,
1047 			   NULL)
1048 };
1049 
1050 static const struct of_device_id dwc3_qcom_of_match[] = {
1051 	{ .compatible = "qcom,dwc3" },
1052 	{ }
1053 };
1054 MODULE_DEVICE_TABLE(of, dwc3_qcom_of_match);
1055 
1056 #ifdef CONFIG_ACPI
1057 static const struct dwc3_acpi_pdata sdm845_acpi_pdata = {
1058 	.qscratch_base_offset = SDM845_QSCRATCH_BASE_OFFSET,
1059 	.qscratch_base_size = SDM845_QSCRATCH_SIZE,
1060 	.dwc3_core_base_size = SDM845_DWC3_CORE_SIZE,
1061 	.qusb2_phy_irq_index = 1,
1062 	.dp_hs_phy_irq_index = 4,
1063 	.dm_hs_phy_irq_index = 3,
1064 	.ss_phy_irq_index = 2
1065 };
1066 
1067 static const struct dwc3_acpi_pdata sdm845_acpi_urs_pdata = {
1068 	.qscratch_base_offset = SDM845_QSCRATCH_BASE_OFFSET,
1069 	.qscratch_base_size = SDM845_QSCRATCH_SIZE,
1070 	.dwc3_core_base_size = SDM845_DWC3_CORE_SIZE,
1071 	.qusb2_phy_irq_index = 1,
1072 	.dp_hs_phy_irq_index = 4,
1073 	.dm_hs_phy_irq_index = 3,
1074 	.ss_phy_irq_index = 2,
1075 	.is_urs = true,
1076 };
1077 
1078 static const struct acpi_device_id dwc3_qcom_acpi_match[] = {
1079 	{ "QCOM2430", (unsigned long)&sdm845_acpi_pdata },
1080 	{ "QCOM0304", (unsigned long)&sdm845_acpi_urs_pdata },
1081 	{ "QCOM0497", (unsigned long)&sdm845_acpi_urs_pdata },
1082 	{ "QCOM04A6", (unsigned long)&sdm845_acpi_pdata },
1083 	{ },
1084 };
1085 MODULE_DEVICE_TABLE(acpi, dwc3_qcom_acpi_match);
1086 #endif
1087 
1088 static struct platform_driver dwc3_qcom_driver = {
1089 	.probe		= dwc3_qcom_probe,
1090 	.remove_new	= dwc3_qcom_remove,
1091 	.driver		= {
1092 		.name	= "dwc3-qcom",
1093 		.pm	= &dwc3_qcom_dev_pm_ops,
1094 		.of_match_table	= dwc3_qcom_of_match,
1095 		.acpi_match_table = ACPI_PTR(dwc3_qcom_acpi_match),
1096 	},
1097 };
1098 
1099 module_platform_driver(dwc3_qcom_driver);
1100 
1101 MODULE_LICENSE("GPL v2");
1102 MODULE_DESCRIPTION("DesignWare DWC3 QCOM Glue Driver");
1103