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.h>
13 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/of_gpio.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/reset.h>
18 #include <linux/slab.h>
19 #include <linux/sysfs.h>
26 * image of renesas_usbhs
32 * mod_host.c pipe.c fifo.c
34 * +-------+ +-----------+
35 * | pipe0 |------>| fifo pio |
36 * +------------+ +-------+ +-----------+
37 * | mod_gadget |=====> | pipe1 |--+
38 * +------------+ +-------+ | +-----------+
39 * | pipe2 | | +-| fifo dma0 |
40 * +------------+ +-------+ | | +-----------+
41 * | mod_host | | pipe3 |<-|--+
42 * +------------+ +-------+ | +-----------+
43 * | .... | +--->| fifo dma1 |
44 * | .... | +-----------+
50 * renesas usb support platform callback function.
51 * Below macro call it.
52 * if platform doesn't have callback, it return 0 (no error)
54 #define usbhs_platform_call(priv, func, args...)\
55 (!(priv) ? -ENODEV : \
56 !((priv)->pfunc->func) ? 0 : \
57 (priv)->pfunc->func(args))
62 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
64 return ioread16(priv->base + reg);
67 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
69 iowrite16(data, priv->base + reg);
72 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
74 u16 val = usbhs_read(priv, reg);
79 usbhs_write(priv, reg, val);
82 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
84 return dev_get_drvdata(&pdev->dev);
87 int usbhs_get_id_as_gadget(struct platform_device *pdev)
95 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
97 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
100 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
102 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
103 u16 val = DCFM | DRPD | HSE | USBE;
109 * - D+ Line/D- Line Pull-down
111 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
114 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
116 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
117 u16 val = HSE | USBE;
119 /* CNEN bit is required for function operation */
120 if (usbhs_get_dparam(priv, has_cnen)) {
128 * - select Function mode
129 * - D+ Line Pull-up is disabled
130 * When D+ Line Pull-up is enabled,
131 * calling usbhs_sys_function_pullup(,1)
133 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
136 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
138 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
141 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
143 usbhs_write(priv, TESTMODE, mode);
149 int usbhs_frame_get_num(struct usbhs_priv *priv)
151 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
155 * usb request functions
157 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
161 val = usbhs_read(priv, USBREQ);
162 req->bRequest = (val >> 8) & 0xFF;
163 req->bRequestType = (val >> 0) & 0xFF;
165 req->wValue = usbhs_read(priv, USBVAL);
166 req->wIndex = usbhs_read(priv, USBINDX);
167 req->wLength = usbhs_read(priv, USBLENG);
170 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
172 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
173 usbhs_write(priv, USBVAL, req->wValue);
174 usbhs_write(priv, USBINDX, req->wIndex);
175 usbhs_write(priv, USBLENG, req->wLength);
177 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
183 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
185 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
187 if (status != USBRST) {
188 struct device *dev = usbhs_priv_to_dev(priv);
189 dev_err(dev, "usbhs should be reset\n");
192 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
195 void usbhs_bus_send_reset(struct usbhs_priv *priv)
197 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
200 int usbhs_bus_get_speed(struct usbhs_priv *priv)
202 u16 dvstctr = usbhs_read(priv, DVSTCTR);
204 switch (RHST & dvstctr) {
206 return USB_SPEED_LOW;
207 case RHST_FULL_SPEED:
208 return USB_SPEED_FULL;
209 case RHST_HIGH_SPEED:
210 return USB_SPEED_HIGH;
213 return USB_SPEED_UNKNOWN;
216 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
218 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
220 return usbhs_platform_call(priv, set_vbus, pdev, enable);
223 static void usbhsc_bus_init(struct usbhs_priv *priv)
225 usbhs_write(priv, DVSTCTR, 0);
227 usbhs_vbus_ctrl(priv, 0);
231 * device configuration
233 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
234 u16 upphub, u16 hubport, u16 speed)
236 struct device *dev = usbhs_priv_to_dev(priv);
238 u32 reg = DEVADD0 + (2 * devnum);
241 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
246 dev_err(dev, "unsupported hub number %d\n", upphub);
252 usbspd = USBSPD_SPEED_LOW;
255 usbspd = USBSPD_SPEED_FULL;
258 usbspd = USBSPD_SPEED_HIGH;
261 dev_err(dev, "unsupported speed %d\n", speed);
265 usbhs_write(priv, reg, UPPHUB(upphub) |
273 * interrupt functions
275 void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
277 u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
279 usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
285 static void usbhsc_set_buswait(struct usbhs_priv *priv)
287 int wait = usbhs_get_dparam(priv, buswait_bwait);
289 /* set bus wait if platform have */
291 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
294 static bool usbhsc_is_multi_clks(struct usbhs_priv *priv)
296 return priv->dparam.multi_clks;
299 static int usbhsc_clk_get(struct device *dev, struct usbhs_priv *priv)
301 if (!usbhsc_is_multi_clks(priv))
304 /* The first clock should exist */
305 priv->clks[0] = of_clk_get(dev_of_node(dev), 0);
306 if (IS_ERR(priv->clks[0]))
307 return PTR_ERR(priv->clks[0]);
310 * To backward compatibility with old DT, this driver checks the return
311 * value if it's -ENOENT or not.
313 priv->clks[1] = of_clk_get(dev_of_node(dev), 1);
314 if (PTR_ERR(priv->clks[1]) == -ENOENT)
315 priv->clks[1] = NULL;
316 else if (IS_ERR(priv->clks[1]))
317 return PTR_ERR(priv->clks[1]);
322 static void usbhsc_clk_put(struct usbhs_priv *priv)
326 if (!usbhsc_is_multi_clks(priv))
329 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
330 clk_put(priv->clks[i]);
333 static int usbhsc_clk_prepare_enable(struct usbhs_priv *priv)
337 if (!usbhsc_is_multi_clks(priv))
340 for (i = 0; i < ARRAY_SIZE(priv->clks); i++) {
341 ret = clk_prepare_enable(priv->clks[i]);
344 clk_disable_unprepare(priv->clks[i]);
352 static void usbhsc_clk_disable_unprepare(struct usbhs_priv *priv)
356 if (!usbhsc_is_multi_clks(priv))
359 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
360 clk_disable_unprepare(priv->clks[i]);
364 * platform default param
367 /* commonly used on old SH-Mobile SoCs */
368 static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
369 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
370 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, false),
371 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
372 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
373 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
374 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
375 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
376 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
377 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
378 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
381 /* commonly used on newer SH-Mobile and R-Car SoCs */
382 static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
383 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
384 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
385 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
386 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
387 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
388 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
389 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
390 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
391 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
392 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
393 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
394 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
395 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
396 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
397 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
398 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
404 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
406 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
407 struct device *dev = usbhs_priv_to_dev(priv);
411 pm_runtime_get_sync(dev);
414 if (usbhsc_clk_prepare_enable(priv))
417 /* enable platform power */
418 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
421 usbhs_sys_clock_ctrl(priv, enable);
424 usbhs_sys_clock_ctrl(priv, enable);
426 /* disable platform power */
427 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
430 usbhsc_clk_disable_unprepare(priv);
433 pm_runtime_put_sync(dev);
440 static void usbhsc_hotplug(struct usbhs_priv *priv)
442 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
443 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
450 * get vbus status from platform
452 enable = usbhs_mod_info_call(priv, get_vbus, pdev);
455 * get id from platform
457 id = usbhs_platform_call(priv, get_id, pdev);
459 if (enable && !mod) {
461 cable = extcon_get_state(priv->edev, EXTCON_USB_HOST);
462 if ((cable > 0 && id != USBHS_HOST) ||
463 (!cable && id != USBHS_GADGET)) {
465 "USB cable plugged in doesn't match the selected role!\n");
470 ret = usbhs_mod_change(priv, id);
474 dev_dbg(&pdev->dev, "%s enable\n", __func__);
477 if (usbhs_get_dparam(priv, runtime_pwctrl))
478 usbhsc_power_ctrl(priv, enable);
481 usbhsc_set_buswait(priv);
482 usbhsc_bus_init(priv);
485 usbhs_mod_call(priv, start, priv);
487 } else if (!enable && mod) {
488 dev_dbg(&pdev->dev, "%s disable\n", __func__);
491 usbhs_mod_call(priv, stop, priv);
494 usbhsc_bus_init(priv);
497 if (usbhs_get_dparam(priv, runtime_pwctrl))
498 usbhsc_power_ctrl(priv, enable);
500 usbhs_mod_change(priv, -1);
502 /* reset phy for next connection */
503 usbhs_platform_call(priv, phy_reset, pdev);
510 static void usbhsc_notify_hotplug(struct work_struct *work)
512 struct usbhs_priv *priv = container_of(work,
514 notify_hotplug_work.work);
515 usbhsc_hotplug(priv);
518 int usbhsc_schedule_notify_hotplug(struct platform_device *pdev)
520 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
521 int delay = usbhs_get_dparam(priv, detection_delay);
524 * This functions will be called in interrupt.
525 * To make sure safety context,
526 * use workqueue for usbhs_notify_hotplug
528 schedule_delayed_work(&priv->notify_hotplug_work,
529 msecs_to_jiffies(delay));
536 static const struct of_device_id usbhs_of_match[] = {
538 .compatible = "renesas,usbhs-r8a774c0",
539 .data = &usbhs_rcar_gen3_with_pll_plat_info,
542 .compatible = "renesas,usbhs-r8a7790",
543 .data = &usbhs_rcar_gen2_plat_info,
546 .compatible = "renesas,usbhs-r8a7791",
547 .data = &usbhs_rcar_gen2_plat_info,
550 .compatible = "renesas,usbhs-r8a7794",
551 .data = &usbhs_rcar_gen2_plat_info,
554 .compatible = "renesas,usbhs-r8a7795",
555 .data = &usbhs_rcar_gen3_plat_info,
558 .compatible = "renesas,usbhs-r8a7796",
559 .data = &usbhs_rcar_gen3_plat_info,
562 .compatible = "renesas,usbhs-r8a77990",
563 .data = &usbhs_rcar_gen3_with_pll_plat_info,
566 .compatible = "renesas,usbhs-r8a77995",
567 .data = &usbhs_rcar_gen3_with_pll_plat_info,
570 .compatible = "renesas,rcar-gen2-usbhs",
571 .data = &usbhs_rcar_gen2_plat_info,
574 .compatible = "renesas,rcar-gen3-usbhs",
575 .data = &usbhs_rcar_gen3_plat_info,
578 .compatible = "renesas,rza1-usbhs",
579 .data = &usbhs_rza1_plat_info,
582 .compatible = "renesas,rza2-usbhs",
583 .data = &usbhs_rza2_plat_info,
587 MODULE_DEVICE_TABLE(of, usbhs_of_match);
589 static int usbhs_probe(struct platform_device *pdev)
591 const struct renesas_usbhs_platform_info *info;
592 struct usbhs_priv *priv;
593 struct resource *res, *irq_res;
594 struct device *dev = &pdev->dev;
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_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
613 dev_err(dev, "Not enough Renesas USB platform resources.\n");
617 /* usb private data */
618 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
622 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
623 priv->base = devm_ioremap_resource(&pdev->dev, res);
624 if (IS_ERR(priv->base))
625 return PTR_ERR(priv->base);
627 if (of_property_read_bool(dev_of_node(dev), "extcon")) {
628 priv->edev = extcon_get_edev_by_phandle(dev, 0);
629 if (IS_ERR(priv->edev))
630 return PTR_ERR(priv->edev);
633 priv->rsts = devm_reset_control_array_get_optional_shared(dev);
634 if (IS_ERR(priv->rsts))
635 return PTR_ERR(priv->rsts);
641 priv->dparam = info->driver_param;
643 if (!info->platform_callback.get_id) {
644 dev_err(dev, "no platform callbacks\n");
647 priv->pfunc = &info->platform_callback;
649 /* set default param if platform doesn't have */
650 if (usbhs_get_dparam(priv, has_new_pipe_configs)) {
651 priv->dparam.pipe_configs = usbhsc_new_pipe;
652 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
653 } else if (!priv->dparam.pipe_configs) {
654 priv->dparam.pipe_configs = usbhsc_default_pipe;
655 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
657 if (!priv->dparam.pio_dma_border)
658 priv->dparam.pio_dma_border = 64; /* 64byte */
659 if (!of_property_read_u32(dev_of_node(dev), "renesas,buswait", &tmp))
660 priv->dparam.buswait_bwait = tmp;
661 gpio = of_get_named_gpio_flags(dev_of_node(dev), "renesas,enable-gpio",
664 priv->dparam.enable_gpio = gpio;
667 /* runtime power control ? */
668 if (priv->pfunc->get_vbus)
669 usbhs_get_dparam(priv, runtime_pwctrl) = 1;
674 priv->irq = irq_res->start;
675 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
676 priv->irqflags = IRQF_SHARED;
678 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
679 spin_lock_init(usbhs_priv_to_lock(priv));
681 /* call pipe and module init */
682 ret = usbhs_pipe_probe(priv);
686 ret = usbhs_fifo_probe(priv);
688 goto probe_end_pipe_exit;
690 ret = usbhs_mod_probe(priv);
692 goto probe_end_fifo_exit;
694 /* dev_set_drvdata should be called after usbhs_mod_init */
695 platform_set_drvdata(pdev, priv);
697 ret = reset_control_deassert(priv->rsts);
701 ret = usbhsc_clk_get(dev, priv);
703 goto probe_fail_clks;
706 * deviece reset here because
707 * USB device might be used in boot loader.
709 usbhs_sys_clock_ctrl(priv, 0);
711 /* check GPIO determining if USB function should be enabled */
712 if (priv->dparam.enable_gpio) {
713 gpio_request_one(priv->dparam.enable_gpio, GPIOF_IN, NULL);
714 ret = !gpio_get_value(priv->dparam.enable_gpio);
715 gpio_free(priv->dparam.enable_gpio);
717 dev_warn(dev, "USB function not selected (GPIO %d)\n",
718 priv->dparam.enable_gpio);
720 goto probe_end_mod_exit;
727 * USB phy setup might depend on CPU/Board.
728 * If platform has its callback functions,
731 ret = usbhs_platform_call(priv, hardware_init, pdev);
733 dev_err(dev, "platform init failed.\n");
734 goto probe_end_mod_exit;
737 /* reset phy for connection */
738 usbhs_platform_call(priv, phy_reset, pdev);
741 pm_runtime_enable(dev);
742 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
743 usbhsc_power_ctrl(priv, 1);
744 usbhs_mod_autonomy_mode(priv);
746 usbhs_mod_non_autonomy_mode(priv);
750 * manual call notify_hotplug for cold plug
752 usbhsc_schedule_notify_hotplug(pdev);
754 dev_info(dev, "probed\n");
759 usbhsc_clk_put(priv);
761 reset_control_assert(priv->rsts);
763 usbhs_mod_remove(priv);
765 usbhs_fifo_remove(priv);
767 usbhs_pipe_remove(priv);
769 dev_info(dev, "probe failed (%d)\n", ret);
774 static int usbhs_remove(struct platform_device *pdev)
776 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
778 dev_dbg(&pdev->dev, "usb remove\n");
781 if (!usbhs_get_dparam(priv, runtime_pwctrl))
782 usbhsc_power_ctrl(priv, 0);
784 pm_runtime_disable(&pdev->dev);
786 usbhs_platform_call(priv, hardware_exit, pdev);
787 usbhsc_clk_put(priv);
788 reset_control_assert(priv->rsts);
789 usbhs_mod_remove(priv);
790 usbhs_fifo_remove(priv);
791 usbhs_pipe_remove(priv);
796 static __maybe_unused int usbhsc_suspend(struct device *dev)
798 struct usbhs_priv *priv = dev_get_drvdata(dev);
799 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
802 usbhs_mod_call(priv, stop, priv);
803 usbhs_mod_change(priv, -1);
806 if (mod || !usbhs_get_dparam(priv, runtime_pwctrl))
807 usbhsc_power_ctrl(priv, 0);
812 static __maybe_unused int usbhsc_resume(struct device *dev)
814 struct usbhs_priv *priv = dev_get_drvdata(dev);
815 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
817 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
818 usbhsc_power_ctrl(priv, 1);
819 usbhs_mod_autonomy_mode(priv);
822 usbhs_platform_call(priv, phy_reset, pdev);
824 usbhsc_schedule_notify_hotplug(pdev);
829 static SIMPLE_DEV_PM_OPS(usbhsc_pm_ops, usbhsc_suspend, usbhsc_resume);
831 static struct platform_driver renesas_usbhs_driver = {
833 .name = "renesas_usbhs",
834 .pm = &usbhsc_pm_ops,
835 .of_match_table = of_match_ptr(usbhs_of_match),
837 .probe = usbhs_probe,
838 .remove = usbhs_remove,
841 module_platform_driver(renesas_usbhs_driver);
843 MODULE_LICENSE("GPL");
844 MODULE_DESCRIPTION("Renesas USB driver");