4 * Copyright (C) 2011 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 #include <linux/err.h>
18 #include <linux/gpio.h>
20 #include <linux/module.h>
21 #include <linux/of_device.h>
22 #include <linux/of_gpio.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/slab.h>
25 #include <linux/sysfs.h>
31 * image of renesas_usbhs
37 * mod_host.c pipe.c fifo.c
39 * +-------+ +-----------+
40 * | pipe0 |------>| fifo pio |
41 * +------------+ +-------+ +-----------+
42 * | mod_gadget |=====> | pipe1 |--+
43 * +------------+ +-------+ | +-----------+
44 * | pipe2 | | +-| fifo dma0 |
45 * +------------+ +-------+ | | +-----------+
46 * | mod_host | | pipe3 |<-|--+
47 * +------------+ +-------+ | +-----------+
48 * | .... | +--->| fifo dma1 |
49 * | .... | +-----------+
53 #define USBHSF_RUNTIME_PWCTRL (1 << 0)
56 #define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
57 #define usbhsc_flags_set(p, b) ((p)->flags |= (b))
58 #define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
59 #define usbhsc_flags_has(p, b) ((p)->flags & (b))
64 * renesas usb support platform callback function.
65 * Below macro call it.
66 * if platform doesn't have callback, it return 0 (no error)
68 #define usbhs_platform_call(priv, func, args...)\
69 (!(priv) ? -ENODEV : \
70 !((priv)->pfunc.func) ? 0 : \
71 (priv)->pfunc.func(args))
76 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
78 return ioread16(priv->base + reg);
81 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
83 iowrite16(data, priv->base + reg);
86 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
88 u16 val = usbhs_read(priv, reg);
93 usbhs_write(priv, reg, val);
96 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
98 return dev_get_drvdata(&pdev->dev);
104 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
106 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
109 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
111 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
112 u16 val = DCFM | DRPD | HSE | USBE;
113 int has_otg = usbhs_get_dparam(priv, has_otg);
116 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
122 * - D+ Line/D- Line Pull-down
124 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
127 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
129 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
130 u16 val = HSE | USBE;
135 * - select Function mode
136 * - D+ Line Pull-up is disabled
137 * When D+ Line Pull-up is enabled,
138 * calling usbhs_sys_function_pullup(,1)
140 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
143 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
145 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
148 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
150 usbhs_write(priv, TESTMODE, mode);
156 int usbhs_frame_get_num(struct usbhs_priv *priv)
158 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
162 * usb request functions
164 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
168 val = usbhs_read(priv, USBREQ);
169 req->bRequest = (val >> 8) & 0xFF;
170 req->bRequestType = (val >> 0) & 0xFF;
172 req->wValue = usbhs_read(priv, USBVAL);
173 req->wIndex = usbhs_read(priv, USBINDX);
174 req->wLength = usbhs_read(priv, USBLENG);
177 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
179 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
180 usbhs_write(priv, USBVAL, req->wValue);
181 usbhs_write(priv, USBINDX, req->wIndex);
182 usbhs_write(priv, USBLENG, req->wLength);
184 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
190 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
192 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
194 if (status != USBRST) {
195 struct device *dev = usbhs_priv_to_dev(priv);
196 dev_err(dev, "usbhs should be reset\n");
199 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
202 void usbhs_bus_send_reset(struct usbhs_priv *priv)
204 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
207 int usbhs_bus_get_speed(struct usbhs_priv *priv)
209 u16 dvstctr = usbhs_read(priv, DVSTCTR);
211 switch (RHST & dvstctr) {
213 return USB_SPEED_LOW;
214 case RHST_FULL_SPEED:
215 return USB_SPEED_FULL;
216 case RHST_HIGH_SPEED:
217 return USB_SPEED_HIGH;
220 return USB_SPEED_UNKNOWN;
223 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
225 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
227 return usbhs_platform_call(priv, set_vbus, pdev, enable);
230 static void usbhsc_bus_init(struct usbhs_priv *priv)
232 usbhs_write(priv, DVSTCTR, 0);
234 usbhs_vbus_ctrl(priv, 0);
238 * device configuration
240 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
241 u16 upphub, u16 hubport, u16 speed)
243 struct device *dev = usbhs_priv_to_dev(priv);
245 u32 reg = DEVADD0 + (2 * devnum);
248 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
253 dev_err(dev, "unsupported hub number %d\n", upphub);
259 usbspd = USBSPD_SPEED_LOW;
262 usbspd = USBSPD_SPEED_FULL;
265 usbspd = USBSPD_SPEED_HIGH;
268 dev_err(dev, "unsupported speed %d\n", speed);
272 usbhs_write(priv, reg, UPPHUB(upphub) |
280 * interrupt functions
282 void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
284 u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
286 usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
292 static void usbhsc_set_buswait(struct usbhs_priv *priv)
294 int wait = usbhs_get_dparam(priv, buswait_bwait);
296 /* set bus wait if platform have */
298 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
302 * platform default param
305 /* commonly used on old SH-Mobile SoCs */
306 static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
307 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
308 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, false),
309 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
310 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
311 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
312 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
313 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
314 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
315 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
316 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
319 /* commonly used on newer SH-Mobile and R-Car SoCs */
320 static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
321 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
322 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
323 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
324 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
325 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
326 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
327 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
328 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
329 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
330 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
331 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
332 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
333 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
334 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
335 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
336 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
342 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
344 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
345 struct device *dev = usbhs_priv_to_dev(priv);
349 pm_runtime_get_sync(dev);
351 /* enable platform power */
352 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
355 usbhs_sys_clock_ctrl(priv, enable);
358 usbhs_sys_clock_ctrl(priv, enable);
360 /* disable platform power */
361 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
364 pm_runtime_put_sync(dev);
371 static void usbhsc_hotplug(struct usbhs_priv *priv)
373 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
374 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
381 * get vbus status from platform
383 enable = usbhs_platform_call(priv, get_vbus, pdev);
386 * get id from platform
388 id = usbhs_platform_call(priv, get_id, pdev);
390 if (enable && !mod) {
392 cable = extcon_get_cable_state_(priv->edev, EXTCON_USB_HOST);
393 if ((cable > 0 && id != USBHS_HOST) ||
394 (!cable && id != USBHS_GADGET)) {
396 "USB cable plugged in doesn't match the selected role!\n");
401 ret = usbhs_mod_change(priv, id);
405 dev_dbg(&pdev->dev, "%s enable\n", __func__);
408 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
409 usbhsc_power_ctrl(priv, enable);
412 usbhsc_set_buswait(priv);
413 usbhsc_bus_init(priv);
416 usbhs_mod_call(priv, start, priv);
418 } else if (!enable && mod) {
419 dev_dbg(&pdev->dev, "%s disable\n", __func__);
422 usbhs_mod_call(priv, stop, priv);
425 usbhsc_bus_init(priv);
428 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
429 usbhsc_power_ctrl(priv, enable);
431 usbhs_mod_change(priv, -1);
433 /* reset phy for next connection */
434 usbhs_platform_call(priv, phy_reset, pdev);
441 static void usbhsc_notify_hotplug(struct work_struct *work)
443 struct usbhs_priv *priv = container_of(work,
445 notify_hotplug_work.work);
446 usbhsc_hotplug(priv);
449 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
451 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
452 int delay = usbhs_get_dparam(priv, detection_delay);
455 * This functions will be called in interrupt.
456 * To make sure safety context,
457 * use workqueue for usbhs_notify_hotplug
459 schedule_delayed_work(&priv->notify_hotplug_work,
460 msecs_to_jiffies(delay));
467 static const struct of_device_id usbhs_of_match[] = {
469 .compatible = "renesas,usbhs-r8a7790",
470 .data = (void *)USBHS_TYPE_RCAR_GEN2,
473 .compatible = "renesas,usbhs-r8a7791",
474 .data = (void *)USBHS_TYPE_RCAR_GEN2,
477 .compatible = "renesas,usbhs-r8a7794",
478 .data = (void *)USBHS_TYPE_RCAR_GEN2,
481 .compatible = "renesas,usbhs-r8a7795",
482 .data = (void *)USBHS_TYPE_RCAR_GEN3,
485 .compatible = "renesas,rcar-gen2-usbhs",
486 .data = (void *)USBHS_TYPE_RCAR_GEN2,
489 .compatible = "renesas,rcar-gen3-usbhs",
490 .data = (void *)USBHS_TYPE_RCAR_GEN3,
494 MODULE_DEVICE_TABLE(of, usbhs_of_match);
496 static struct renesas_usbhs_platform_info *usbhs_parse_dt(struct device *dev)
498 struct renesas_usbhs_platform_info *info;
499 struct renesas_usbhs_driver_param *dparam;
500 const struct of_device_id *of_id = of_match_device(usbhs_of_match, dev);
504 info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
508 dparam = &info->driver_param;
509 dparam->type = of_id ? (uintptr_t)of_id->data : 0;
510 if (!of_property_read_u32(dev->of_node, "renesas,buswait", &tmp))
511 dparam->buswait_bwait = tmp;
512 gpio = of_get_named_gpio_flags(dev->of_node, "renesas,enable-gpio", 0,
515 dparam->enable_gpio = gpio;
517 if (dparam->type == USBHS_TYPE_RCAR_GEN2 ||
518 dparam->type == USBHS_TYPE_RCAR_GEN3)
519 dparam->has_usb_dmac = 1;
524 static int usbhs_probe(struct platform_device *pdev)
526 struct renesas_usbhs_platform_info *info = dev_get_platdata(&pdev->dev);
527 struct renesas_usbhs_driver_callback *dfunc;
528 struct usbhs_priv *priv;
529 struct resource *res, *irq_res;
532 /* check device node */
533 if (pdev->dev.of_node)
534 info = pdev->dev.platform_data = usbhs_parse_dt(&pdev->dev);
536 /* check platform information */
538 dev_err(&pdev->dev, "no platform information\n");
543 irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
545 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
549 /* usb private data */
550 priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
554 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
555 priv->base = devm_ioremap_resource(&pdev->dev, res);
556 if (IS_ERR(priv->base))
557 return PTR_ERR(priv->base);
559 if (of_property_read_bool(pdev->dev.of_node, "extcon")) {
560 priv->edev = extcon_get_edev_by_phandle(&pdev->dev, 0);
561 if (IS_ERR(priv->edev))
562 return PTR_ERR(priv->edev);
569 memcpy(&priv->dparam,
571 sizeof(struct renesas_usbhs_driver_param));
573 switch (priv->dparam.type) {
574 case USBHS_TYPE_RCAR_GEN2:
575 priv->pfunc = usbhs_rcar2_ops;
576 if (!priv->dparam.pipe_configs) {
577 priv->dparam.pipe_configs = usbhsc_new_pipe;
578 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
581 case USBHS_TYPE_RCAR_GEN3:
582 priv->pfunc = usbhs_rcar3_ops;
583 if (!priv->dparam.pipe_configs) {
584 priv->dparam.pipe_configs = usbhsc_new_pipe;
585 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
589 if (!info->platform_callback.get_id) {
590 dev_err(&pdev->dev, "no platform callbacks");
594 &info->platform_callback,
595 sizeof(struct renesas_usbhs_platform_callback));
599 /* set driver callback functions for platform */
600 dfunc = &info->driver_callback;
601 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
603 /* set default param if platform doesn't have */
604 if (!priv->dparam.pipe_configs) {
605 priv->dparam.pipe_configs = usbhsc_default_pipe;
606 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
608 if (!priv->dparam.pio_dma_border)
609 priv->dparam.pio_dma_border = 64; /* 64byte */
612 /* runtime power control ? */
613 if (priv->pfunc.get_vbus)
614 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
619 priv->irq = irq_res->start;
620 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
621 priv->irqflags = IRQF_SHARED;
623 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
624 spin_lock_init(usbhs_priv_to_lock(priv));
626 /* call pipe and module init */
627 ret = usbhs_pipe_probe(priv);
631 ret = usbhs_fifo_probe(priv);
633 goto probe_end_pipe_exit;
635 ret = usbhs_mod_probe(priv);
637 goto probe_end_fifo_exit;
639 /* dev_set_drvdata should be called after usbhs_mod_init */
640 platform_set_drvdata(pdev, priv);
643 * deviece reset here because
644 * USB device might be used in boot loader.
646 usbhs_sys_clock_ctrl(priv, 0);
648 /* check GPIO determining if USB function should be enabled */
649 if (priv->dparam.enable_gpio) {
650 gpio_request_one(priv->dparam.enable_gpio, GPIOF_IN, NULL);
651 ret = !gpio_get_value(priv->dparam.enable_gpio);
652 gpio_free(priv->dparam.enable_gpio);
655 "USB function not selected (GPIO %d)\n",
656 priv->dparam.enable_gpio);
658 goto probe_end_mod_exit;
665 * USB phy setup might depend on CPU/Board.
666 * If platform has its callback functions,
669 ret = usbhs_platform_call(priv, hardware_init, pdev);
671 dev_err(&pdev->dev, "platform init failed.\n");
672 goto probe_end_mod_exit;
675 /* reset phy for connection */
676 usbhs_platform_call(priv, phy_reset, pdev);
679 pm_runtime_enable(&pdev->dev);
680 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
681 usbhsc_power_ctrl(priv, 1);
682 usbhs_mod_autonomy_mode(priv);
686 * manual call notify_hotplug for cold plug
688 usbhsc_drvcllbck_notify_hotplug(pdev);
690 dev_info(&pdev->dev, "probed\n");
695 usbhs_mod_remove(priv);
697 usbhs_fifo_remove(priv);
699 usbhs_pipe_remove(priv);
701 dev_info(&pdev->dev, "probe failed (%d)\n", ret);
706 static int usbhs_remove(struct platform_device *pdev)
708 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
709 struct renesas_usbhs_platform_info *info = dev_get_platdata(&pdev->dev);
710 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
712 dev_dbg(&pdev->dev, "usb remove\n");
714 dfunc->notify_hotplug = NULL;
717 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
718 usbhsc_power_ctrl(priv, 0);
720 pm_runtime_disable(&pdev->dev);
722 usbhs_platform_call(priv, hardware_exit, pdev);
723 usbhs_mod_remove(priv);
724 usbhs_fifo_remove(priv);
725 usbhs_pipe_remove(priv);
730 static int usbhsc_suspend(struct device *dev)
732 struct usbhs_priv *priv = dev_get_drvdata(dev);
733 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
736 usbhs_mod_call(priv, stop, priv);
737 usbhs_mod_change(priv, -1);
740 if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
741 usbhsc_power_ctrl(priv, 0);
746 static int usbhsc_resume(struct device *dev)
748 struct usbhs_priv *priv = dev_get_drvdata(dev);
749 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
751 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
752 usbhsc_power_ctrl(priv, 1);
754 usbhs_platform_call(priv, phy_reset, pdev);
756 usbhsc_drvcllbck_notify_hotplug(pdev);
761 static int usbhsc_runtime_nop(struct device *dev)
763 /* Runtime PM callback shared between ->runtime_suspend()
764 * and ->runtime_resume(). Simply returns success.
766 * This driver re-initializes all registers after
767 * pm_runtime_get_sync() anyway so there is no need
768 * to save and restore registers here.
773 static const struct dev_pm_ops usbhsc_pm_ops = {
774 .suspend = usbhsc_suspend,
775 .resume = usbhsc_resume,
776 .runtime_suspend = usbhsc_runtime_nop,
777 .runtime_resume = usbhsc_runtime_nop,
780 static struct platform_driver renesas_usbhs_driver = {
782 .name = "renesas_usbhs",
783 .pm = &usbhsc_pm_ops,
784 .of_match_table = of_match_ptr(usbhs_of_match),
786 .probe = usbhs_probe,
787 .remove = usbhs_remove,
790 module_platform_driver(renesas_usbhs_driver);
792 MODULE_LICENSE("GPL");
793 MODULE_DESCRIPTION("Renesas USB driver");
794 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");