xref: /openbmc/linux/drivers/usb/renesas_usbhs/common.c (revision 8ebc80a25f9d9bf7a8e368b266d5b740c485c362)
1 // SPDX-License-Identifier: GPL-1.0+
2 /*
3  * Renesas USB driver
4  *
5  * Copyright (C) 2011 Renesas Solutions Corp.
6  * Copyright (C) 2019 Renesas Electronics Corporation
7  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8  */
9 #include <linux/clk.h>
10 #include <linux/err.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/io.h>
13 #include <linux/module.h>
14 #include <linux/of.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/reset.h>
17 #include <linux/slab.h>
18 #include <linux/sysfs.h>
19 #include "common.h"
20 #include "rcar2.h"
21 #include "rcar3.h"
22 #include "rza.h"
23 
24 /*
25  *		image of renesas_usbhs
26  *
27  * ex) gadget case
28 
29  * mod.c
30  * mod_gadget.c
31  * mod_host.c		pipe.c		fifo.c
32  *
33  *			+-------+	+-----------+
34  *			| pipe0 |------>| fifo pio  |
35  * +------------+	+-------+	+-----------+
36  * | mod_gadget |=====> | pipe1 |--+
37  * +------------+	+-------+  |	+-----------+
38  *			| pipe2 |  |  +-| fifo dma0 |
39  * +------------+	+-------+  |  |	+-----------+
40  * | mod_host   |	| pipe3 |<-|--+
41  * +------------+	+-------+  |	+-----------+
42  *			| ....  |  +--->| fifo dma1 |
43  *			| ....  |	+-----------+
44  */
45 
46 /*
47  * platform call back
48  *
49  * renesas usb support platform callback function.
50  * Below macro call it.
51  * if platform doesn't have callback, it return 0 (no error)
52  */
53 #define usbhs_platform_call(priv, func, args...)\
54 	(!(priv) ? -ENODEV :			\
55 	 !((priv)->pfunc->func) ? 0 :		\
56 	 (priv)->pfunc->func(args))
57 
58 /*
59  *		common functions
60  */
usbhs_read(struct usbhs_priv * priv,u32 reg)61 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
62 {
63 	return ioread16(priv->base + reg);
64 }
65 
usbhs_write(struct usbhs_priv * priv,u32 reg,u16 data)66 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
67 {
68 	iowrite16(data, priv->base + reg);
69 }
70 
usbhs_bset(struct usbhs_priv * priv,u32 reg,u16 mask,u16 data)71 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
72 {
73 	u16 val = usbhs_read(priv, reg);
74 
75 	val &= ~mask;
76 	val |= data & mask;
77 
78 	usbhs_write(priv, reg, val);
79 }
80 
usbhs_pdev_to_priv(struct platform_device * pdev)81 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
82 {
83 	return dev_get_drvdata(&pdev->dev);
84 }
85 
usbhs_get_id_as_gadget(struct platform_device * pdev)86 int usbhs_get_id_as_gadget(struct platform_device *pdev)
87 {
88 	return USBHS_GADGET;
89 }
90 
91 /*
92  *		syscfg functions
93  */
usbhs_sys_clock_ctrl(struct usbhs_priv * priv,int enable)94 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
95 {
96 	usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
97 }
98 
usbhs_sys_host_ctrl(struct usbhs_priv * priv,int enable)99 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
100 {
101 	u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
102 	u16 val  = DCFM | DRPD | HSE | USBE;
103 
104 	/*
105 	 * if enable
106 	 *
107 	 * - select Host mode
108 	 * - D+ Line/D- Line Pull-down
109 	 */
110 	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
111 }
112 
usbhs_sys_function_ctrl(struct usbhs_priv * priv,int enable)113 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
114 {
115 	u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
116 	u16 val  = HSE | USBE;
117 
118 	/* CNEN bit is required for function operation */
119 	if (usbhs_get_dparam(priv, has_cnen)) {
120 		mask |= CNEN;
121 		val  |= CNEN;
122 	}
123 
124 	/*
125 	 * if enable
126 	 *
127 	 * - select Function mode
128 	 * - D+ Line Pull-up is disabled
129 	 *      When D+ Line Pull-up is enabled,
130 	 *      calling usbhs_sys_function_pullup(,1)
131 	 */
132 	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
133 }
134 
usbhs_sys_function_pullup(struct usbhs_priv * priv,int enable)135 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
136 {
137 	usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
138 }
139 
usbhs_sys_set_test_mode(struct usbhs_priv * priv,u16 mode)140 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
141 {
142 	usbhs_write(priv, TESTMODE, mode);
143 }
144 
145 /*
146  *		frame functions
147  */
usbhs_frame_get_num(struct usbhs_priv * priv)148 int usbhs_frame_get_num(struct usbhs_priv *priv)
149 {
150 	return usbhs_read(priv, FRMNUM) & FRNM_MASK;
151 }
152 
153 /*
154  *		usb request functions
155  */
usbhs_usbreq_get_val(struct usbhs_priv * priv,struct usb_ctrlrequest * req)156 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
157 {
158 	u16 val;
159 
160 	val = usbhs_read(priv, USBREQ);
161 	req->bRequest		= (val >> 8) & 0xFF;
162 	req->bRequestType	= (val >> 0) & 0xFF;
163 
164 	req->wValue	= cpu_to_le16(usbhs_read(priv, USBVAL));
165 	req->wIndex	= cpu_to_le16(usbhs_read(priv, USBINDX));
166 	req->wLength	= cpu_to_le16(usbhs_read(priv, USBLENG));
167 }
168 
usbhs_usbreq_set_val(struct usbhs_priv * priv,struct usb_ctrlrequest * req)169 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
170 {
171 	usbhs_write(priv, USBREQ,  (req->bRequest << 8) | req->bRequestType);
172 	usbhs_write(priv, USBVAL,  le16_to_cpu(req->wValue));
173 	usbhs_write(priv, USBINDX, le16_to_cpu(req->wIndex));
174 	usbhs_write(priv, USBLENG, le16_to_cpu(req->wLength));
175 
176 	usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
177 }
178 
179 /*
180  *		bus/vbus functions
181  */
usbhs_bus_send_sof_enable(struct usbhs_priv * priv)182 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
183 {
184 	u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
185 
186 	if (status != USBRST) {
187 		struct device *dev = usbhs_priv_to_dev(priv);
188 		dev_err(dev, "usbhs should be reset\n");
189 	}
190 
191 	usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
192 }
193 
usbhs_bus_send_reset(struct usbhs_priv * priv)194 void usbhs_bus_send_reset(struct usbhs_priv *priv)
195 {
196 	usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
197 }
198 
usbhs_bus_get_speed(struct usbhs_priv * priv)199 int usbhs_bus_get_speed(struct usbhs_priv *priv)
200 {
201 	u16 dvstctr = usbhs_read(priv, DVSTCTR);
202 
203 	switch (RHST & dvstctr) {
204 	case RHST_LOW_SPEED:
205 		return USB_SPEED_LOW;
206 	case RHST_FULL_SPEED:
207 		return USB_SPEED_FULL;
208 	case RHST_HIGH_SPEED:
209 		return USB_SPEED_HIGH;
210 	}
211 
212 	return USB_SPEED_UNKNOWN;
213 }
214 
usbhs_vbus_ctrl(struct usbhs_priv * priv,int enable)215 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
216 {
217 	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
218 
219 	return usbhs_platform_call(priv, set_vbus, pdev, enable);
220 }
221 
usbhsc_bus_init(struct usbhs_priv * priv)222 static void usbhsc_bus_init(struct usbhs_priv *priv)
223 {
224 	usbhs_write(priv, DVSTCTR, 0);
225 
226 	usbhs_vbus_ctrl(priv, 0);
227 }
228 
229 /*
230  *		device configuration
231  */
usbhs_set_device_config(struct usbhs_priv * priv,int devnum,u16 upphub,u16 hubport,u16 speed)232 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
233 			   u16 upphub, u16 hubport, u16 speed)
234 {
235 	struct device *dev = usbhs_priv_to_dev(priv);
236 	u16 usbspd = 0;
237 	u32 reg = DEVADD0 + (2 * devnum);
238 
239 	if (devnum > 10) {
240 		dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
241 		return -EIO;
242 	}
243 
244 	if (upphub > 0xA) {
245 		dev_err(dev, "unsupported hub number %d\n", upphub);
246 		return -EIO;
247 	}
248 
249 	switch (speed) {
250 	case USB_SPEED_LOW:
251 		usbspd = USBSPD_SPEED_LOW;
252 		break;
253 	case USB_SPEED_FULL:
254 		usbspd = USBSPD_SPEED_FULL;
255 		break;
256 	case USB_SPEED_HIGH:
257 		usbspd = USBSPD_SPEED_HIGH;
258 		break;
259 	default:
260 		dev_err(dev, "unsupported speed %d\n", speed);
261 		return -EIO;
262 	}
263 
264 	usbhs_write(priv, reg,	UPPHUB(upphub)	|
265 				HUBPORT(hubport)|
266 				USBSPD(usbspd));
267 
268 	return 0;
269 }
270 
271 /*
272  *		interrupt functions
273  */
usbhs_xxxsts_clear(struct usbhs_priv * priv,u16 sts_reg,u16 bit)274 void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
275 {
276 	u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
277 
278 	usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
279 }
280 
281 /*
282  *		local functions
283  */
usbhsc_set_buswait(struct usbhs_priv * priv)284 static void usbhsc_set_buswait(struct usbhs_priv *priv)
285 {
286 	int wait = usbhs_get_dparam(priv, buswait_bwait);
287 
288 	/* set bus wait if platform have */
289 	if (wait)
290 		usbhs_bset(priv, BUSWAIT, 0x000F, wait);
291 }
292 
usbhsc_is_multi_clks(struct usbhs_priv * priv)293 static bool usbhsc_is_multi_clks(struct usbhs_priv *priv)
294 {
295 	return priv->dparam.multi_clks;
296 }
297 
usbhsc_clk_get(struct device * dev,struct usbhs_priv * priv)298 static int usbhsc_clk_get(struct device *dev, struct usbhs_priv *priv)
299 {
300 	if (!usbhsc_is_multi_clks(priv))
301 		return 0;
302 
303 	/* The first clock should exist */
304 	priv->clks[0] = of_clk_get(dev_of_node(dev), 0);
305 	if (IS_ERR(priv->clks[0]))
306 		return PTR_ERR(priv->clks[0]);
307 
308 	/*
309 	 * To backward compatibility with old DT, this driver checks the return
310 	 * value if it's -ENOENT or not.
311 	 */
312 	priv->clks[1] = of_clk_get(dev_of_node(dev), 1);
313 	if (PTR_ERR(priv->clks[1]) == -ENOENT)
314 		priv->clks[1] = NULL;
315 	else if (IS_ERR(priv->clks[1])) {
316 		clk_put(priv->clks[0]);
317 		return PTR_ERR(priv->clks[1]);
318 	}
319 
320 	return 0;
321 }
322 
usbhsc_clk_put(struct usbhs_priv * priv)323 static void usbhsc_clk_put(struct usbhs_priv *priv)
324 {
325 	int i;
326 
327 	if (!usbhsc_is_multi_clks(priv))
328 		return;
329 
330 	for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
331 		clk_put(priv->clks[i]);
332 }
333 
usbhsc_clk_prepare_enable(struct usbhs_priv * priv)334 static int usbhsc_clk_prepare_enable(struct usbhs_priv *priv)
335 {
336 	int i, ret;
337 
338 	if (!usbhsc_is_multi_clks(priv))
339 		return 0;
340 
341 	for (i = 0; i < ARRAY_SIZE(priv->clks); i++) {
342 		ret = clk_prepare_enable(priv->clks[i]);
343 		if (ret) {
344 			while (--i >= 0)
345 				clk_disable_unprepare(priv->clks[i]);
346 			return ret;
347 		}
348 	}
349 
350 	return ret;
351 }
352 
usbhsc_clk_disable_unprepare(struct usbhs_priv * priv)353 static void usbhsc_clk_disable_unprepare(struct usbhs_priv *priv)
354 {
355 	int i;
356 
357 	if (!usbhsc_is_multi_clks(priv))
358 		return;
359 
360 	for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
361 		clk_disable_unprepare(priv->clks[i]);
362 }
363 
364 /*
365  *		platform default param
366  */
367 
368 /* commonly used on old SH-Mobile SoCs */
369 static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
370 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
371 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, false),
372 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
373 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
374 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
375 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
376 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
377 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
378 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
379 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
380 };
381 
382 /* commonly used on newer SH-Mobile and R-Car SoCs */
383 static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
384 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
385 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
386 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
387 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
388 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
389 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
390 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
391 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
392 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
393 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
394 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
395 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
396 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
397 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
398 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
399 	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
400 };
401 
402 /*
403  *		power control
404  */
usbhsc_power_ctrl(struct usbhs_priv * priv,int enable)405 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
406 {
407 	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
408 	struct device *dev = usbhs_priv_to_dev(priv);
409 
410 	if (enable) {
411 		/* enable PM */
412 		pm_runtime_get_sync(dev);
413 
414 		/* enable clks */
415 		if (usbhsc_clk_prepare_enable(priv))
416 			return;
417 
418 		/* enable platform power */
419 		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
420 
421 		/* USB on */
422 		usbhs_sys_clock_ctrl(priv, enable);
423 	} else {
424 		/* USB off */
425 		usbhs_sys_clock_ctrl(priv, enable);
426 
427 		/* disable platform power */
428 		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
429 
430 		/* disable clks */
431 		usbhsc_clk_disable_unprepare(priv);
432 
433 		/* disable PM */
434 		pm_runtime_put_sync(dev);
435 	}
436 }
437 
438 /*
439  *		hotplug
440  */
usbhsc_hotplug(struct usbhs_priv * priv)441 static void usbhsc_hotplug(struct usbhs_priv *priv)
442 {
443 	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
444 	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
445 	int id;
446 	int enable;
447 	int cable;
448 	int ret;
449 
450 	/*
451 	 * get vbus status from platform
452 	 */
453 	enable = usbhs_mod_info_call(priv, get_vbus, pdev);
454 
455 	/*
456 	 * get id from platform
457 	 */
458 	id = usbhs_platform_call(priv, get_id, pdev);
459 
460 	if (enable && !mod) {
461 		if (priv->edev) {
462 			cable = extcon_get_state(priv->edev, EXTCON_USB_HOST);
463 			if ((cable > 0 && id != USBHS_HOST) ||
464 			    (!cable && id != USBHS_GADGET)) {
465 				dev_info(&pdev->dev,
466 					 "USB cable plugged in doesn't match the selected role!\n");
467 				return;
468 			}
469 		}
470 
471 		ret = usbhs_mod_change(priv, id);
472 		if (ret < 0)
473 			return;
474 
475 		dev_dbg(&pdev->dev, "%s enable\n", __func__);
476 
477 		/* power on */
478 		if (usbhs_get_dparam(priv, runtime_pwctrl))
479 			usbhsc_power_ctrl(priv, enable);
480 
481 		/* bus init */
482 		usbhsc_set_buswait(priv);
483 		usbhsc_bus_init(priv);
484 
485 		/* module start */
486 		usbhs_mod_call(priv, start, priv);
487 
488 	} else if (!enable && mod) {
489 		dev_dbg(&pdev->dev, "%s disable\n", __func__);
490 
491 		/* module stop */
492 		usbhs_mod_call(priv, stop, priv);
493 
494 		/* bus init */
495 		usbhsc_bus_init(priv);
496 
497 		/* power off */
498 		if (usbhs_get_dparam(priv, runtime_pwctrl))
499 			usbhsc_power_ctrl(priv, enable);
500 
501 		usbhs_mod_change(priv, -1);
502 
503 		/* reset phy for next connection */
504 		usbhs_platform_call(priv, phy_reset, pdev);
505 	}
506 }
507 
508 /*
509  *		notify hotplug
510  */
usbhsc_notify_hotplug(struct work_struct * work)511 static void usbhsc_notify_hotplug(struct work_struct *work)
512 {
513 	struct usbhs_priv *priv = container_of(work,
514 					       struct usbhs_priv,
515 					       notify_hotplug_work.work);
516 	usbhsc_hotplug(priv);
517 }
518 
usbhsc_schedule_notify_hotplug(struct platform_device * pdev)519 int usbhsc_schedule_notify_hotplug(struct platform_device *pdev)
520 {
521 	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
522 	int delay = usbhs_get_dparam(priv, detection_delay);
523 
524 	/*
525 	 * This functions will be called in interrupt.
526 	 * To make sure safety context,
527 	 * use workqueue for usbhs_notify_hotplug
528 	 */
529 	schedule_delayed_work(&priv->notify_hotplug_work,
530 			      msecs_to_jiffies(delay));
531 	return 0;
532 }
533 
534 /*
535  *		platform functions
536  */
537 static const struct of_device_id usbhs_of_match[] = {
538 	{
539 		.compatible = "renesas,usbhs-r8a774c0",
540 		.data = &usbhs_rcar_gen3_with_pll_plat_info,
541 	},
542 	{
543 		.compatible = "renesas,usbhs-r8a7790",
544 		.data = &usbhs_rcar_gen2_plat_info,
545 	},
546 	{
547 		.compatible = "renesas,usbhs-r8a7791",
548 		.data = &usbhs_rcar_gen2_plat_info,
549 	},
550 	{
551 		.compatible = "renesas,usbhs-r8a7794",
552 		.data = &usbhs_rcar_gen2_plat_info,
553 	},
554 	{
555 		.compatible = "renesas,usbhs-r8a7795",
556 		.data = &usbhs_rcar_gen3_plat_info,
557 	},
558 	{
559 		.compatible = "renesas,usbhs-r8a7796",
560 		.data = &usbhs_rcar_gen3_plat_info,
561 	},
562 	{
563 		.compatible = "renesas,usbhs-r8a77990",
564 		.data = &usbhs_rcar_gen3_with_pll_plat_info,
565 	},
566 	{
567 		.compatible = "renesas,usbhs-r8a77995",
568 		.data = &usbhs_rcar_gen3_with_pll_plat_info,
569 	},
570 	{
571 		.compatible = "renesas,rcar-gen2-usbhs",
572 		.data = &usbhs_rcar_gen2_plat_info,
573 	},
574 	{
575 		.compatible = "renesas,rcar-gen3-usbhs",
576 		.data = &usbhs_rcar_gen3_plat_info,
577 	},
578 	{
579 		.compatible = "renesas,rza1-usbhs",
580 		.data = &usbhs_rza1_plat_info,
581 	},
582 	{
583 		.compatible = "renesas,rza2-usbhs",
584 		.data = &usbhs_rza2_plat_info,
585 	},
586 	{ },
587 };
588 MODULE_DEVICE_TABLE(of, usbhs_of_match);
589 
usbhs_probe(struct platform_device * pdev)590 static int usbhs_probe(struct platform_device *pdev)
591 {
592 	const struct renesas_usbhs_platform_info *info;
593 	struct usbhs_priv *priv;
594 	struct device *dev = &pdev->dev;
595 	struct gpio_desc *gpiod;
596 	int ret;
597 	u32 tmp;
598 	int irq;
599 
600 	/* check device node */
601 	if (dev_of_node(dev))
602 		info = of_device_get_match_data(dev);
603 	else
604 		info = renesas_usbhs_get_info(pdev);
605 
606 	/* check platform information */
607 	if (!info) {
608 		dev_err(dev, "no platform information\n");
609 		return -EINVAL;
610 	}
611 
612 	/* platform data */
613 	irq = platform_get_irq(pdev, 0);
614 	if (irq < 0)
615 		return irq;
616 
617 	/* usb private data */
618 	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
619 	if (!priv)
620 		return -ENOMEM;
621 
622 	priv->base = devm_platform_ioremap_resource(pdev, 0);
623 	if (IS_ERR(priv->base))
624 		return PTR_ERR(priv->base);
625 
626 	if (of_property_read_bool(dev_of_node(dev), "extcon")) {
627 		priv->edev = extcon_get_edev_by_phandle(dev, 0);
628 		if (IS_ERR(priv->edev))
629 			return PTR_ERR(priv->edev);
630 	}
631 
632 	priv->rsts = devm_reset_control_array_get_optional_shared(dev);
633 	if (IS_ERR(priv->rsts))
634 		return PTR_ERR(priv->rsts);
635 
636 	/*
637 	 * care platform info
638 	 */
639 
640 	priv->dparam = info->driver_param;
641 
642 	if (!info->platform_callback.get_id) {
643 		dev_err(dev, "no platform callbacks\n");
644 		return -EINVAL;
645 	}
646 	priv->pfunc = &info->platform_callback;
647 
648 	/* set default param if platform doesn't have */
649 	if (usbhs_get_dparam(priv, has_new_pipe_configs)) {
650 		priv->dparam.pipe_configs = usbhsc_new_pipe;
651 		priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
652 	} else if (!priv->dparam.pipe_configs) {
653 		priv->dparam.pipe_configs = usbhsc_default_pipe;
654 		priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
655 	}
656 	if (!priv->dparam.pio_dma_border)
657 		priv->dparam.pio_dma_border = 64; /* 64byte */
658 	if (!of_property_read_u32(dev_of_node(dev), "renesas,buswait", &tmp))
659 		priv->dparam.buswait_bwait = tmp;
660 	gpiod = devm_gpiod_get_optional(dev, "renesas,enable", GPIOD_IN);
661 	if (IS_ERR(gpiod))
662 		return PTR_ERR(gpiod);
663 
664 	/* FIXME */
665 	/* runtime power control ? */
666 	if (priv->pfunc->get_vbus)
667 		usbhs_get_dparam(priv, runtime_pwctrl) = 1;
668 
669 	/*
670 	 * priv settings
671 	 */
672 	priv->irq = irq;
673 	priv->pdev	= pdev;
674 	INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
675 	spin_lock_init(usbhs_priv_to_lock(priv));
676 
677 	/* call pipe and module init */
678 	ret = usbhs_pipe_probe(priv);
679 	if (ret < 0)
680 		return ret;
681 
682 	ret = usbhs_fifo_probe(priv);
683 	if (ret < 0)
684 		goto probe_end_pipe_exit;
685 
686 	ret = usbhs_mod_probe(priv);
687 	if (ret < 0)
688 		goto probe_end_fifo_exit;
689 
690 	/* dev_set_drvdata should be called after usbhs_mod_init */
691 	platform_set_drvdata(pdev, priv);
692 
693 	ret = reset_control_deassert(priv->rsts);
694 	if (ret)
695 		goto probe_fail_rst;
696 
697 	ret = usbhsc_clk_get(dev, priv);
698 	if (ret)
699 		goto probe_fail_clks;
700 
701 	/*
702 	 * deviece reset here because
703 	 * USB device might be used in boot loader.
704 	 */
705 	usbhs_sys_clock_ctrl(priv, 0);
706 
707 	/* check GPIO determining if USB function should be enabled */
708 	if (gpiod) {
709 		ret = !gpiod_get_value(gpiod);
710 		if (ret) {
711 			dev_warn(dev, "USB function not selected (GPIO)\n");
712 			ret = -ENOTSUPP;
713 			goto probe_end_mod_exit;
714 		}
715 	}
716 
717 	/*
718 	 * platform call
719 	 *
720 	 * USB phy setup might depend on CPU/Board.
721 	 * If platform has its callback functions,
722 	 * call it here.
723 	 */
724 	ret = usbhs_platform_call(priv, hardware_init, pdev);
725 	if (ret < 0) {
726 		dev_err(dev, "platform init failed.\n");
727 		goto probe_end_mod_exit;
728 	}
729 
730 	/* reset phy for connection */
731 	usbhs_platform_call(priv, phy_reset, pdev);
732 
733 	/* power control */
734 	pm_runtime_enable(dev);
735 	if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
736 		usbhsc_power_ctrl(priv, 1);
737 		usbhs_mod_autonomy_mode(priv);
738 	} else {
739 		usbhs_mod_non_autonomy_mode(priv);
740 	}
741 
742 	/*
743 	 * manual call notify_hotplug for cold plug
744 	 */
745 	usbhsc_schedule_notify_hotplug(pdev);
746 
747 	dev_info(dev, "probed\n");
748 
749 	return ret;
750 
751 probe_end_mod_exit:
752 	usbhsc_clk_put(priv);
753 probe_fail_clks:
754 	reset_control_assert(priv->rsts);
755 probe_fail_rst:
756 	usbhs_mod_remove(priv);
757 probe_end_fifo_exit:
758 	usbhs_fifo_remove(priv);
759 probe_end_pipe_exit:
760 	usbhs_pipe_remove(priv);
761 
762 	dev_info(dev, "probe failed (%d)\n", ret);
763 
764 	return ret;
765 }
766 
usbhs_remove(struct platform_device * pdev)767 static void usbhs_remove(struct platform_device *pdev)
768 {
769 	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
770 
771 	dev_dbg(&pdev->dev, "usb remove\n");
772 
773 	flush_delayed_work(&priv->notify_hotplug_work);
774 
775 	/* power off */
776 	if (!usbhs_get_dparam(priv, runtime_pwctrl))
777 		usbhsc_power_ctrl(priv, 0);
778 
779 	pm_runtime_disable(&pdev->dev);
780 
781 	usbhs_platform_call(priv, hardware_exit, pdev);
782 	usbhsc_clk_put(priv);
783 	reset_control_assert(priv->rsts);
784 	usbhs_mod_remove(priv);
785 	usbhs_fifo_remove(priv);
786 	usbhs_pipe_remove(priv);
787 }
788 
usbhsc_suspend(struct device * dev)789 static __maybe_unused int usbhsc_suspend(struct device *dev)
790 {
791 	struct usbhs_priv *priv = dev_get_drvdata(dev);
792 	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
793 
794 	if (mod) {
795 		usbhs_mod_call(priv, stop, priv);
796 		usbhs_mod_change(priv, -1);
797 	}
798 
799 	if (mod || !usbhs_get_dparam(priv, runtime_pwctrl))
800 		usbhsc_power_ctrl(priv, 0);
801 
802 	return 0;
803 }
804 
usbhsc_resume(struct device * dev)805 static __maybe_unused int usbhsc_resume(struct device *dev)
806 {
807 	struct usbhs_priv *priv = dev_get_drvdata(dev);
808 	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
809 
810 	if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
811 		usbhsc_power_ctrl(priv, 1);
812 		usbhs_mod_autonomy_mode(priv);
813 	}
814 
815 	usbhs_platform_call(priv, phy_reset, pdev);
816 
817 	usbhsc_schedule_notify_hotplug(pdev);
818 
819 	return 0;
820 }
821 
822 static SIMPLE_DEV_PM_OPS(usbhsc_pm_ops, usbhsc_suspend, usbhsc_resume);
823 
824 static struct platform_driver renesas_usbhs_driver = {
825 	.driver		= {
826 		.name	= "renesas_usbhs",
827 		.pm	= &usbhsc_pm_ops,
828 		.of_match_table = usbhs_of_match,
829 	},
830 	.probe		= usbhs_probe,
831 	.remove_new	= usbhs_remove,
832 };
833 
834 module_platform_driver(renesas_usbhs_driver);
835 
836 MODULE_LICENSE("GPL");
837 MODULE_DESCRIPTION("Renesas USB driver");
838 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
839