1 // SPDX-License-Identifier: GPL-1.0+
5 * Copyright (C) 2011 Renesas Solutions Corp.
6 * Copyright (C) 2019 Renesas Electronics Corporation
10 #include <linux/err.h>
11 #include <linux/gpio/consumer.h>
13 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/reset.h>
17 #include <linux/slab.h>
18 #include <linux/sysfs.h>
25 * image of renesas_usbhs
31 * mod_host.c pipe.c fifo.c
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 * | .... | +-----------+
49 * renesas usb support platform callback function.
50 * Below macro call it.
51 * if platform doesn't have callback, it return 0 (no error)
53 #define usbhs_platform_call(priv, func, args...)\
54 (!(priv) ? -ENODEV : \
55 !((priv)->pfunc->func) ? 0 : \
56 (priv)->pfunc->func(args))
61 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
63 return ioread16(priv->base + reg);
66 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
68 iowrite16(data, priv->base + reg);
71 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
73 u16 val = usbhs_read(priv, reg);
78 usbhs_write(priv, reg, val);
81 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
83 return dev_get_drvdata(&pdev->dev);
86 int usbhs_get_id_as_gadget(struct platform_device *pdev)
94 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
96 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
99 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
101 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
102 u16 val = DCFM | DRPD | HSE | USBE;
108 * - D+ Line/D- Line Pull-down
110 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
113 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
115 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
116 u16 val = HSE | USBE;
118 /* CNEN bit is required for function operation */
119 if (usbhs_get_dparam(priv, has_cnen)) {
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)
132 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
135 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
137 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
140 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
142 usbhs_write(priv, TESTMODE, mode);
148 int usbhs_frame_get_num(struct usbhs_priv *priv)
150 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
154 * usb request functions
156 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
160 val = usbhs_read(priv, USBREQ);
161 req->bRequest = (val >> 8) & 0xFF;
162 req->bRequestType = (val >> 0) & 0xFF;
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));
169 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
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));
176 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
182 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
184 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
186 if (status != USBRST) {
187 struct device *dev = usbhs_priv_to_dev(priv);
188 dev_err(dev, "usbhs should be reset\n");
191 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
194 void usbhs_bus_send_reset(struct usbhs_priv *priv)
196 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
199 int usbhs_bus_get_speed(struct usbhs_priv *priv)
201 u16 dvstctr = usbhs_read(priv, DVSTCTR);
203 switch (RHST & dvstctr) {
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;
212 return USB_SPEED_UNKNOWN;
215 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
217 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
219 return usbhs_platform_call(priv, set_vbus, pdev, enable);
222 static void usbhsc_bus_init(struct usbhs_priv *priv)
224 usbhs_write(priv, DVSTCTR, 0);
226 usbhs_vbus_ctrl(priv, 0);
230 * device configuration
232 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
233 u16 upphub, u16 hubport, u16 speed)
235 struct device *dev = usbhs_priv_to_dev(priv);
237 u32 reg = DEVADD0 + (2 * devnum);
240 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
245 dev_err(dev, "unsupported hub number %d\n", upphub);
251 usbspd = USBSPD_SPEED_LOW;
254 usbspd = USBSPD_SPEED_FULL;
257 usbspd = USBSPD_SPEED_HIGH;
260 dev_err(dev, "unsupported speed %d\n", speed);
264 usbhs_write(priv, reg, UPPHUB(upphub) |
272 * interrupt functions
274 void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
276 u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
278 usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
284 static void usbhsc_set_buswait(struct usbhs_priv *priv)
286 int wait = usbhs_get_dparam(priv, buswait_bwait);
288 /* set bus wait if platform have */
290 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
293 static bool usbhsc_is_multi_clks(struct usbhs_priv *priv)
295 return priv->dparam.multi_clks;
298 static int usbhsc_clk_get(struct device *dev, struct usbhs_priv *priv)
300 if (!usbhsc_is_multi_clks(priv))
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]);
309 * To backward compatibility with old DT, this driver checks the return
310 * value if it's -ENOENT or not.
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]);
321 static void usbhsc_clk_put(struct usbhs_priv *priv)
325 if (!usbhsc_is_multi_clks(priv))
328 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
329 clk_put(priv->clks[i]);
332 static int usbhsc_clk_prepare_enable(struct usbhs_priv *priv)
336 if (!usbhsc_is_multi_clks(priv))
339 for (i = 0; i < ARRAY_SIZE(priv->clks); i++) {
340 ret = clk_prepare_enable(priv->clks[i]);
343 clk_disable_unprepare(priv->clks[i]);
351 static void usbhsc_clk_disable_unprepare(struct usbhs_priv *priv)
355 if (!usbhsc_is_multi_clks(priv))
358 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
359 clk_disable_unprepare(priv->clks[i]);
363 * platform default param
366 /* commonly used on old SH-Mobile 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, false),
370 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
371 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
372 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
373 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, 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),
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),
403 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
405 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
406 struct device *dev = usbhs_priv_to_dev(priv);
410 pm_runtime_get_sync(dev);
413 if (usbhsc_clk_prepare_enable(priv))
416 /* enable platform power */
417 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
420 usbhs_sys_clock_ctrl(priv, enable);
423 usbhs_sys_clock_ctrl(priv, enable);
425 /* disable platform power */
426 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
429 usbhsc_clk_disable_unprepare(priv);
432 pm_runtime_put_sync(dev);
439 static void usbhsc_hotplug(struct usbhs_priv *priv)
441 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
442 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
449 * get vbus status from platform
451 enable = usbhs_mod_info_call(priv, get_vbus, pdev);
454 * get id from platform
456 id = usbhs_platform_call(priv, get_id, pdev);
458 if (enable && !mod) {
460 cable = extcon_get_state(priv->edev, EXTCON_USB_HOST);
461 if ((cable > 0 && id != USBHS_HOST) ||
462 (!cable && id != USBHS_GADGET)) {
464 "USB cable plugged in doesn't match the selected role!\n");
469 ret = usbhs_mod_change(priv, id);
473 dev_dbg(&pdev->dev, "%s enable\n", __func__);
476 if (usbhs_get_dparam(priv, runtime_pwctrl))
477 usbhsc_power_ctrl(priv, enable);
480 usbhsc_set_buswait(priv);
481 usbhsc_bus_init(priv);
484 usbhs_mod_call(priv, start, priv);
486 } else if (!enable && mod) {
487 dev_dbg(&pdev->dev, "%s disable\n", __func__);
490 usbhs_mod_call(priv, stop, priv);
493 usbhsc_bus_init(priv);
496 if (usbhs_get_dparam(priv, runtime_pwctrl))
497 usbhsc_power_ctrl(priv, enable);
499 usbhs_mod_change(priv, -1);
501 /* reset phy for next connection */
502 usbhs_platform_call(priv, phy_reset, pdev);
509 static void usbhsc_notify_hotplug(struct work_struct *work)
511 struct usbhs_priv *priv = container_of(work,
513 notify_hotplug_work.work);
514 usbhsc_hotplug(priv);
517 int usbhsc_schedule_notify_hotplug(struct platform_device *pdev)
519 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
520 int delay = usbhs_get_dparam(priv, detection_delay);
523 * This functions will be called in interrupt.
524 * To make sure safety context,
525 * use workqueue for usbhs_notify_hotplug
527 schedule_delayed_work(&priv->notify_hotplug_work,
528 msecs_to_jiffies(delay));
535 static const struct of_device_id usbhs_of_match[] = {
537 .compatible = "renesas,usbhs-r8a774c0",
538 .data = &usbhs_rcar_gen3_with_pll_plat_info,
541 .compatible = "renesas,usbhs-r8a7790",
542 .data = &usbhs_rcar_gen2_plat_info,
545 .compatible = "renesas,usbhs-r8a7791",
546 .data = &usbhs_rcar_gen2_plat_info,
549 .compatible = "renesas,usbhs-r8a7794",
550 .data = &usbhs_rcar_gen2_plat_info,
553 .compatible = "renesas,usbhs-r8a7795",
554 .data = &usbhs_rcar_gen3_plat_info,
557 .compatible = "renesas,usbhs-r8a7796",
558 .data = &usbhs_rcar_gen3_plat_info,
561 .compatible = "renesas,usbhs-r8a77990",
562 .data = &usbhs_rcar_gen3_with_pll_plat_info,
565 .compatible = "renesas,usbhs-r8a77995",
566 .data = &usbhs_rcar_gen3_with_pll_plat_info,
569 .compatible = "renesas,rcar-gen2-usbhs",
570 .data = &usbhs_rcar_gen2_plat_info,
573 .compatible = "renesas,rcar-gen3-usbhs",
574 .data = &usbhs_rcar_gen3_plat_info,
577 .compatible = "renesas,rza1-usbhs",
578 .data = &usbhs_rza1_plat_info,
581 .compatible = "renesas,rza2-usbhs",
582 .data = &usbhs_rza2_plat_info,
586 MODULE_DEVICE_TABLE(of, usbhs_of_match);
588 static int usbhs_probe(struct platform_device *pdev)
590 const struct renesas_usbhs_platform_info *info;
591 struct usbhs_priv *priv;
592 struct device *dev = &pdev->dev;
593 struct gpio_desc *gpiod;
598 /* check device node */
599 if (dev_of_node(dev))
600 info = of_device_get_match_data(dev);
602 info = renesas_usbhs_get_info(pdev);
604 /* check platform information */
606 dev_err(dev, "no platform information\n");
611 irq = platform_get_irq(pdev, 0);
615 /* usb private data */
616 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
620 priv->base = devm_platform_ioremap_resource(pdev, 0);
621 if (IS_ERR(priv->base))
622 return PTR_ERR(priv->base);
624 if (of_property_read_bool(dev_of_node(dev), "extcon")) {
625 priv->edev = extcon_get_edev_by_phandle(dev, 0);
626 if (IS_ERR(priv->edev))
627 return PTR_ERR(priv->edev);
630 priv->rsts = devm_reset_control_array_get_optional_shared(dev);
631 if (IS_ERR(priv->rsts))
632 return PTR_ERR(priv->rsts);
638 priv->dparam = info->driver_param;
640 if (!info->platform_callback.get_id) {
641 dev_err(dev, "no platform callbacks\n");
644 priv->pfunc = &info->platform_callback;
646 /* set default param if platform doesn't have */
647 if (usbhs_get_dparam(priv, has_new_pipe_configs)) {
648 priv->dparam.pipe_configs = usbhsc_new_pipe;
649 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
650 } else if (!priv->dparam.pipe_configs) {
651 priv->dparam.pipe_configs = usbhsc_default_pipe;
652 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
654 if (!priv->dparam.pio_dma_border)
655 priv->dparam.pio_dma_border = 64; /* 64byte */
656 if (!of_property_read_u32(dev_of_node(dev), "renesas,buswait", &tmp))
657 priv->dparam.buswait_bwait = tmp;
658 gpiod = devm_gpiod_get_optional(dev, "renesas,enable", GPIOD_IN);
660 return PTR_ERR(gpiod);
663 /* runtime power control ? */
664 if (priv->pfunc->get_vbus)
665 usbhs_get_dparam(priv, runtime_pwctrl) = 1;
672 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
673 spin_lock_init(usbhs_priv_to_lock(priv));
675 /* call pipe and module init */
676 ret = usbhs_pipe_probe(priv);
680 ret = usbhs_fifo_probe(priv);
682 goto probe_end_pipe_exit;
684 ret = usbhs_mod_probe(priv);
686 goto probe_end_fifo_exit;
688 /* dev_set_drvdata should be called after usbhs_mod_init */
689 platform_set_drvdata(pdev, priv);
691 ret = reset_control_deassert(priv->rsts);
695 ret = usbhsc_clk_get(dev, priv);
697 goto probe_fail_clks;
700 * deviece reset here because
701 * USB device might be used in boot loader.
703 usbhs_sys_clock_ctrl(priv, 0);
705 /* check GPIO determining if USB function should be enabled */
707 ret = !gpiod_get_value(gpiod);
709 dev_warn(dev, "USB function not selected (GPIO)\n");
711 goto probe_end_mod_exit;
718 * USB phy setup might depend on CPU/Board.
719 * If platform has its callback functions,
722 ret = usbhs_platform_call(priv, hardware_init, pdev);
724 dev_err(dev, "platform init failed.\n");
725 goto probe_end_mod_exit;
728 /* reset phy for connection */
729 usbhs_platform_call(priv, phy_reset, pdev);
732 pm_runtime_enable(dev);
733 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
734 usbhsc_power_ctrl(priv, 1);
735 usbhs_mod_autonomy_mode(priv);
737 usbhs_mod_non_autonomy_mode(priv);
741 * manual call notify_hotplug for cold plug
743 usbhsc_schedule_notify_hotplug(pdev);
745 dev_info(dev, "probed\n");
750 usbhsc_clk_put(priv);
752 reset_control_assert(priv->rsts);
754 usbhs_mod_remove(priv);
756 usbhs_fifo_remove(priv);
758 usbhs_pipe_remove(priv);
760 dev_info(dev, "probe failed (%d)\n", ret);
765 static int usbhs_remove(struct platform_device *pdev)
767 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
769 dev_dbg(&pdev->dev, "usb remove\n");
772 if (!usbhs_get_dparam(priv, runtime_pwctrl))
773 usbhsc_power_ctrl(priv, 0);
775 pm_runtime_disable(&pdev->dev);
777 usbhs_platform_call(priv, hardware_exit, pdev);
778 usbhsc_clk_put(priv);
779 reset_control_assert(priv->rsts);
780 usbhs_mod_remove(priv);
781 usbhs_fifo_remove(priv);
782 usbhs_pipe_remove(priv);
787 static __maybe_unused int usbhsc_suspend(struct device *dev)
789 struct usbhs_priv *priv = dev_get_drvdata(dev);
790 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
793 usbhs_mod_call(priv, stop, priv);
794 usbhs_mod_change(priv, -1);
797 if (mod || !usbhs_get_dparam(priv, runtime_pwctrl))
798 usbhsc_power_ctrl(priv, 0);
803 static __maybe_unused int usbhsc_resume(struct device *dev)
805 struct usbhs_priv *priv = dev_get_drvdata(dev);
806 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
808 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
809 usbhsc_power_ctrl(priv, 1);
810 usbhs_mod_autonomy_mode(priv);
813 usbhs_platform_call(priv, phy_reset, pdev);
815 usbhsc_schedule_notify_hotplug(pdev);
820 static SIMPLE_DEV_PM_OPS(usbhsc_pm_ops, usbhsc_suspend, usbhsc_resume);
822 static struct platform_driver renesas_usbhs_driver = {
824 .name = "renesas_usbhs",
825 .pm = &usbhsc_pm_ops,
826 .of_match_table = usbhs_of_match,
828 .probe = usbhs_probe,
829 .remove = usbhs_remove,
832 module_platform_driver(renesas_usbhs_driver);
834 MODULE_LICENSE("GPL");
835 MODULE_DESCRIPTION("Renesas USB driver");