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  		return PTR_ERR(priv->clks[1]);
317  
318  	return 0;
319  }
320  
usbhsc_clk_put(struct usbhs_priv * priv)321  static void usbhsc_clk_put(struct usbhs_priv *priv)
322  {
323  	int i;
324  
325  	if (!usbhsc_is_multi_clks(priv))
326  		return;
327  
328  	for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
329  		clk_put(priv->clks[i]);
330  }
331  
usbhsc_clk_prepare_enable(struct usbhs_priv * priv)332  static int usbhsc_clk_prepare_enable(struct usbhs_priv *priv)
333  {
334  	int i, ret;
335  
336  	if (!usbhsc_is_multi_clks(priv))
337  		return 0;
338  
339  	for (i = 0; i < ARRAY_SIZE(priv->clks); i++) {
340  		ret = clk_prepare_enable(priv->clks[i]);
341  		if (ret) {
342  			while (--i >= 0)
343  				clk_disable_unprepare(priv->clks[i]);
344  			return ret;
345  		}
346  	}
347  
348  	return ret;
349  }
350  
usbhsc_clk_disable_unprepare(struct usbhs_priv * priv)351  static void usbhsc_clk_disable_unprepare(struct usbhs_priv *priv)
352  {
353  	int i;
354  
355  	if (!usbhsc_is_multi_clks(priv))
356  		return;
357  
358  	for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
359  		clk_disable_unprepare(priv->clks[i]);
360  }
361  
362  /*
363   *		platform default param
364   */
365  
366  /* commonly used on old SH-Mobile and RZ/G2L family SoCs */
367  static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
368  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
369  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
370  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
371  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
372  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
373  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
374  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
375  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
376  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
377  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
378  };
379  
380  /* commonly used on newer SH-Mobile and R-Car SoCs */
381  static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
382  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
383  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
384  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
385  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
386  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
387  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
388  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
389  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
390  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
391  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
392  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
393  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
394  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
395  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
396  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
397  	RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
398  };
399  
400  /*
401   *		power control
402   */
usbhsc_power_ctrl(struct usbhs_priv * priv,int enable)403  static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
404  {
405  	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
406  	struct device *dev = usbhs_priv_to_dev(priv);
407  
408  	if (enable) {
409  		/* enable PM */
410  		pm_runtime_get_sync(dev);
411  
412  		/* enable clks */
413  		if (usbhsc_clk_prepare_enable(priv))
414  			return;
415  
416  		/* enable platform power */
417  		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
418  
419  		/* USB on */
420  		usbhs_sys_clock_ctrl(priv, enable);
421  	} else {
422  		/* USB off */
423  		usbhs_sys_clock_ctrl(priv, enable);
424  
425  		/* disable platform power */
426  		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
427  
428  		/* disable clks */
429  		usbhsc_clk_disable_unprepare(priv);
430  
431  		/* disable PM */
432  		pm_runtime_put_sync(dev);
433  	}
434  }
435  
436  /*
437   *		hotplug
438   */
usbhsc_hotplug(struct usbhs_priv * priv)439  static void usbhsc_hotplug(struct usbhs_priv *priv)
440  {
441  	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
442  	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
443  	int id;
444  	int enable;
445  	int cable;
446  	int ret;
447  
448  	/*
449  	 * get vbus status from platform
450  	 */
451  	enable = usbhs_mod_info_call(priv, get_vbus, pdev);
452  
453  	/*
454  	 * get id from platform
455  	 */
456  	id = usbhs_platform_call(priv, get_id, pdev);
457  
458  	if (enable && !mod) {
459  		if (priv->edev) {
460  			cable = extcon_get_state(priv->edev, EXTCON_USB_HOST);
461  			if ((cable > 0 && id != USBHS_HOST) ||
462  			    (!cable && id != USBHS_GADGET)) {
463  				dev_info(&pdev->dev,
464  					 "USB cable plugged in doesn't match the selected role!\n");
465  				return;
466  			}
467  		}
468  
469  		ret = usbhs_mod_change(priv, id);
470  		if (ret < 0)
471  			return;
472  
473  		dev_dbg(&pdev->dev, "%s enable\n", __func__);
474  
475  		/* power on */
476  		if (usbhs_get_dparam(priv, runtime_pwctrl))
477  			usbhsc_power_ctrl(priv, enable);
478  
479  		/* bus init */
480  		usbhsc_set_buswait(priv);
481  		usbhsc_bus_init(priv);
482  
483  		/* module start */
484  		usbhs_mod_call(priv, start, priv);
485  
486  	} else if (!enable && mod) {
487  		dev_dbg(&pdev->dev, "%s disable\n", __func__);
488  
489  		/* module stop */
490  		usbhs_mod_call(priv, stop, priv);
491  
492  		/* bus init */
493  		usbhsc_bus_init(priv);
494  
495  		/* power off */
496  		if (usbhs_get_dparam(priv, runtime_pwctrl))
497  			usbhsc_power_ctrl(priv, enable);
498  
499  		usbhs_mod_change(priv, -1);
500  
501  		/* reset phy for next connection */
502  		usbhs_platform_call(priv, phy_reset, pdev);
503  	}
504  }
505  
506  /*
507   *		notify hotplug
508   */
usbhsc_notify_hotplug(struct work_struct * work)509  static void usbhsc_notify_hotplug(struct work_struct *work)
510  {
511  	struct usbhs_priv *priv = container_of(work,
512  					       struct usbhs_priv,
513  					       notify_hotplug_work.work);
514  	usbhsc_hotplug(priv);
515  }
516  
usbhsc_schedule_notify_hotplug(struct platform_device * pdev)517  int usbhsc_schedule_notify_hotplug(struct platform_device *pdev)
518  {
519  	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
520  	int delay = usbhs_get_dparam(priv, detection_delay);
521  
522  	/*
523  	 * This functions will be called in interrupt.
524  	 * To make sure safety context,
525  	 * use workqueue for usbhs_notify_hotplug
526  	 */
527  	schedule_delayed_work(&priv->notify_hotplug_work,
528  			      msecs_to_jiffies(delay));
529  	return 0;
530  }
531  
532  /*
533   *		platform functions
534   */
535  static const struct of_device_id usbhs_of_match[] = {
536  	{
537  		.compatible = "renesas,usbhs-r8a774c0",
538  		.data = &usbhs_rcar_gen3_with_pll_plat_info,
539  	},
540  	{
541  		.compatible = "renesas,usbhs-r8a7790",
542  		.data = &usbhs_rcar_gen2_plat_info,
543  	},
544  	{
545  		.compatible = "renesas,usbhs-r8a7791",
546  		.data = &usbhs_rcar_gen2_plat_info,
547  	},
548  	{
549  		.compatible = "renesas,usbhs-r8a7794",
550  		.data = &usbhs_rcar_gen2_plat_info,
551  	},
552  	{
553  		.compatible = "renesas,usbhs-r8a7795",
554  		.data = &usbhs_rcar_gen3_plat_info,
555  	},
556  	{
557  		.compatible = "renesas,usbhs-r8a7796",
558  		.data = &usbhs_rcar_gen3_plat_info,
559  	},
560  	{
561  		.compatible = "renesas,usbhs-r8a77990",
562  		.data = &usbhs_rcar_gen3_with_pll_plat_info,
563  	},
564  	{
565  		.compatible = "renesas,usbhs-r8a77995",
566  		.data = &usbhs_rcar_gen3_with_pll_plat_info,
567  	},
568  	{
569  		.compatible = "renesas,usbhs-r9a07g043",
570  		.data = &usbhs_rzg2l_plat_info,
571  	},
572  	{
573  		.compatible = "renesas,usbhs-r9a07g044",
574  		.data = &usbhs_rzg2l_plat_info,
575  	},
576  	{
577  		.compatible = "renesas,usbhs-r9a07g054",
578  		.data = &usbhs_rzg2l_plat_info,
579  	},
580  	{
581  		.compatible = "renesas,rcar-gen2-usbhs",
582  		.data = &usbhs_rcar_gen2_plat_info,
583  	},
584  	{
585  		.compatible = "renesas,rcar-gen3-usbhs",
586  		.data = &usbhs_rcar_gen3_plat_info,
587  	},
588  	{
589  		.compatible = "renesas,rza1-usbhs",
590  		.data = &usbhs_rza1_plat_info,
591  	},
592  	{
593  		.compatible = "renesas,rza2-usbhs",
594  		.data = &usbhs_rza2_plat_info,
595  	},
596  	{
597  		.compatible = "renesas,rzg2l-usbhs",
598  		.data = &usbhs_rzg2l_plat_info,
599  	},
600  	{ }
601  };
602  MODULE_DEVICE_TABLE(of, usbhs_of_match);
603  
usbhs_probe(struct platform_device * pdev)604  static int usbhs_probe(struct platform_device *pdev)
605  {
606  	const struct renesas_usbhs_platform_info *info;
607  	struct usbhs_priv *priv;
608  	struct device *dev = &pdev->dev;
609  	struct gpio_desc *gpiod;
610  	int ret;
611  	u32 tmp;
612  	int irq;
613  
614  	info = of_device_get_match_data(dev);
615  	if (!info) {
616  		info = dev_get_platdata(dev);
617  		if (!info)
618  			return dev_err_probe(dev, -EINVAL, "no platform info\n");
619  	}
620  
621  	/* platform data */
622  	irq = platform_get_irq(pdev, 0);
623  	if (irq < 0)
624  		return irq;
625  
626  	/* usb private data */
627  	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
628  	if (!priv)
629  		return -ENOMEM;
630  
631  	priv->base = devm_platform_ioremap_resource(pdev, 0);
632  	if (IS_ERR(priv->base))
633  		return PTR_ERR(priv->base);
634  
635  	if (of_property_read_bool(dev_of_node(dev), "extcon")) {
636  		priv->edev = extcon_get_edev_by_phandle(dev, 0);
637  		if (IS_ERR(priv->edev))
638  			return PTR_ERR(priv->edev);
639  	}
640  
641  	priv->rsts = devm_reset_control_array_get_optional_shared(dev);
642  	if (IS_ERR(priv->rsts))
643  		return PTR_ERR(priv->rsts);
644  
645  	/*
646  	 * care platform info
647  	 */
648  
649  	priv->dparam = info->driver_param;
650  
651  	if (!info->platform_callback.get_id) {
652  		dev_err(dev, "no platform callbacks\n");
653  		return -EINVAL;
654  	}
655  	priv->pfunc = &info->platform_callback;
656  
657  	/* set default param if platform doesn't have */
658  	if (usbhs_get_dparam(priv, has_new_pipe_configs)) {
659  		priv->dparam.pipe_configs = usbhsc_new_pipe;
660  		priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
661  	} else if (!priv->dparam.pipe_configs) {
662  		priv->dparam.pipe_configs = usbhsc_default_pipe;
663  		priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
664  	}
665  	if (!priv->dparam.pio_dma_border)
666  		priv->dparam.pio_dma_border = 64; /* 64byte */
667  	if (!of_property_read_u32(dev_of_node(dev), "renesas,buswait", &tmp))
668  		priv->dparam.buswait_bwait = tmp;
669  	gpiod = devm_gpiod_get_optional(dev, "renesas,enable", GPIOD_IN);
670  	if (IS_ERR(gpiod))
671  		return PTR_ERR(gpiod);
672  
673  	/* FIXME */
674  	/* runtime power control ? */
675  	if (priv->pfunc->get_vbus)
676  		usbhs_get_dparam(priv, runtime_pwctrl) = 1;
677  
678  	/*
679  	 * priv settings
680  	 */
681  	priv->irq = irq;
682  	priv->pdev	= pdev;
683  	INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
684  	spin_lock_init(usbhs_priv_to_lock(priv));
685  
686  	/* call pipe and module init */
687  	ret = usbhs_pipe_probe(priv);
688  	if (ret < 0)
689  		return ret;
690  
691  	ret = usbhs_fifo_probe(priv);
692  	if (ret < 0)
693  		goto probe_end_pipe_exit;
694  
695  	ret = usbhs_mod_probe(priv);
696  	if (ret < 0)
697  		goto probe_end_fifo_exit;
698  
699  	/* dev_set_drvdata should be called after usbhs_mod_init */
700  	platform_set_drvdata(pdev, priv);
701  
702  	ret = reset_control_deassert(priv->rsts);
703  	if (ret)
704  		goto probe_fail_rst;
705  
706  	ret = usbhsc_clk_get(dev, priv);
707  	if (ret)
708  		goto probe_fail_clks;
709  
710  	/*
711  	 * deviece reset here because
712  	 * USB device might be used in boot loader.
713  	 */
714  	usbhs_sys_clock_ctrl(priv, 0);
715  
716  	/* check GPIO determining if USB function should be enabled */
717  	if (gpiod) {
718  		ret = !gpiod_get_value(gpiod);
719  		if (ret) {
720  			dev_warn(dev, "USB function not selected (GPIO)\n");
721  			ret = -ENOTSUPP;
722  			goto probe_end_mod_exit;
723  		}
724  	}
725  
726  	/*
727  	 * platform call
728  	 *
729  	 * USB phy setup might depend on CPU/Board.
730  	 * If platform has its callback functions,
731  	 * call it here.
732  	 */
733  	ret = usbhs_platform_call(priv, hardware_init, pdev);
734  	if (ret < 0) {
735  		dev_err(dev, "platform init failed.\n");
736  		goto probe_end_mod_exit;
737  	}
738  
739  	/* reset phy for connection */
740  	usbhs_platform_call(priv, phy_reset, pdev);
741  
742  	/* power control */
743  	pm_runtime_enable(dev);
744  	if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
745  		usbhsc_power_ctrl(priv, 1);
746  		usbhs_mod_autonomy_mode(priv);
747  	} else {
748  		usbhs_mod_non_autonomy_mode(priv);
749  	}
750  
751  	/*
752  	 * manual call notify_hotplug for cold plug
753  	 */
754  	usbhsc_schedule_notify_hotplug(pdev);
755  
756  	dev_info(dev, "probed\n");
757  
758  	return ret;
759  
760  probe_end_mod_exit:
761  	usbhsc_clk_put(priv);
762  probe_fail_clks:
763  	reset_control_assert(priv->rsts);
764  probe_fail_rst:
765  	usbhs_mod_remove(priv);
766  probe_end_fifo_exit:
767  	usbhs_fifo_remove(priv);
768  probe_end_pipe_exit:
769  	usbhs_pipe_remove(priv);
770  
771  	dev_info(dev, "probe failed (%d)\n", ret);
772  
773  	return ret;
774  }
775  
usbhs_remove(struct platform_device * pdev)776  static void usbhs_remove(struct platform_device *pdev)
777  {
778  	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
779  
780  	dev_dbg(&pdev->dev, "usb remove\n");
781  
782  	/* power off */
783  	if (!usbhs_get_dparam(priv, runtime_pwctrl))
784  		usbhsc_power_ctrl(priv, 0);
785  
786  	pm_runtime_disable(&pdev->dev);
787  
788  	usbhs_platform_call(priv, hardware_exit, pdev);
789  	usbhsc_clk_put(priv);
790  	reset_control_assert(priv->rsts);
791  	usbhs_mod_remove(priv);
792  	usbhs_fifo_remove(priv);
793  	usbhs_pipe_remove(priv);
794  }
795  
usbhsc_suspend(struct device * dev)796  static __maybe_unused int usbhsc_suspend(struct device *dev)
797  {
798  	struct usbhs_priv *priv = dev_get_drvdata(dev);
799  	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
800  
801  	if (mod) {
802  		usbhs_mod_call(priv, stop, priv);
803  		usbhs_mod_change(priv, -1);
804  	}
805  
806  	if (mod || !usbhs_get_dparam(priv, runtime_pwctrl))
807  		usbhsc_power_ctrl(priv, 0);
808  
809  	return 0;
810  }
811  
usbhsc_resume(struct device * dev)812  static __maybe_unused int usbhsc_resume(struct device *dev)
813  {
814  	struct usbhs_priv *priv = dev_get_drvdata(dev);
815  	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
816  
817  	if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
818  		usbhsc_power_ctrl(priv, 1);
819  		usbhs_mod_autonomy_mode(priv);
820  	}
821  
822  	usbhs_platform_call(priv, phy_reset, pdev);
823  
824  	usbhsc_schedule_notify_hotplug(pdev);
825  
826  	return 0;
827  }
828  
829  static SIMPLE_DEV_PM_OPS(usbhsc_pm_ops, usbhsc_suspend, usbhsc_resume);
830  
831  static struct platform_driver renesas_usbhs_driver = {
832  	.driver		= {
833  		.name	= "renesas_usbhs",
834  		.pm	= &usbhsc_pm_ops,
835  		.of_match_table = usbhs_of_match,
836  	},
837  	.probe		= usbhs_probe,
838  	.remove_new	= usbhs_remove,
839  };
840  
841  module_platform_driver(renesas_usbhs_driver);
842  
843  MODULE_LICENSE("GPL");
844  MODULE_DESCRIPTION("Renesas USB driver");
845  MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
846