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>
30 * image of renesas_usbhs
36 * mod_host.c pipe.c fifo.c
38 * +-------+ +-----------+
39 * | pipe0 |------>| fifo pio |
40 * +------------+ +-------+ +-----------+
41 * | mod_gadget |=====> | pipe1 |--+
42 * +------------+ +-------+ | +-----------+
43 * | pipe2 | | +-| fifo dma0 |
44 * +------------+ +-------+ | | +-----------+
45 * | mod_host | | pipe3 |<-|--+
46 * +------------+ +-------+ | +-----------+
47 * | .... | +--->| fifo dma1 |
48 * | .... | +-----------+
52 #define USBHSF_RUNTIME_PWCTRL (1 << 0)
55 #define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
56 #define usbhsc_flags_set(p, b) ((p)->flags |= (b))
57 #define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
58 #define usbhsc_flags_has(p, b) ((p)->flags & (b))
63 * renesas usb support platform callback function.
64 * Below macro call it.
65 * if platform doesn't have callback, it return 0 (no error)
67 #define usbhs_platform_call(priv, func, args...)\
68 (!(priv) ? -ENODEV : \
69 !((priv)->pfunc.func) ? 0 : \
70 (priv)->pfunc.func(args))
75 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
77 return ioread16(priv->base + reg);
80 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
82 iowrite16(data, priv->base + reg);
85 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
87 u16 val = usbhs_read(priv, reg);
92 usbhs_write(priv, reg, val);
95 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
97 return dev_get_drvdata(&pdev->dev);
103 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
105 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
108 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
110 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
111 u16 val = DCFM | DRPD | HSE | USBE;
112 int has_otg = usbhs_get_dparam(priv, has_otg);
115 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
121 * - D+ Line/D- Line Pull-down
123 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
126 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
128 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
129 u16 val = HSE | USBE;
134 * - select Function mode
135 * - D+ Line Pull-up is disabled
136 * When D+ Line Pull-up is enabled,
137 * calling usbhs_sys_function_pullup(,1)
139 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
142 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
144 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
147 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
149 usbhs_write(priv, TESTMODE, mode);
155 int usbhs_frame_get_num(struct usbhs_priv *priv)
157 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
161 * usb request functions
163 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
167 val = usbhs_read(priv, USBREQ);
168 req->bRequest = (val >> 8) & 0xFF;
169 req->bRequestType = (val >> 0) & 0xFF;
171 req->wValue = usbhs_read(priv, USBVAL);
172 req->wIndex = usbhs_read(priv, USBINDX);
173 req->wLength = usbhs_read(priv, USBLENG);
176 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
178 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
179 usbhs_write(priv, USBVAL, req->wValue);
180 usbhs_write(priv, USBINDX, req->wIndex);
181 usbhs_write(priv, USBLENG, req->wLength);
183 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
189 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
191 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
193 if (status != USBRST) {
194 struct device *dev = usbhs_priv_to_dev(priv);
195 dev_err(dev, "usbhs should be reset\n");
198 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
201 void usbhs_bus_send_reset(struct usbhs_priv *priv)
203 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
206 int usbhs_bus_get_speed(struct usbhs_priv *priv)
208 u16 dvstctr = usbhs_read(priv, DVSTCTR);
210 switch (RHST & dvstctr) {
212 return USB_SPEED_LOW;
213 case RHST_FULL_SPEED:
214 return USB_SPEED_FULL;
215 case RHST_HIGH_SPEED:
216 return USB_SPEED_HIGH;
219 return USB_SPEED_UNKNOWN;
222 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
224 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
226 return usbhs_platform_call(priv, set_vbus, pdev, enable);
229 static void usbhsc_bus_init(struct usbhs_priv *priv)
231 usbhs_write(priv, DVSTCTR, 0);
233 usbhs_vbus_ctrl(priv, 0);
237 * device configuration
239 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
240 u16 upphub, u16 hubport, u16 speed)
242 struct device *dev = usbhs_priv_to_dev(priv);
244 u32 reg = DEVADD0 + (2 * devnum);
247 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
252 dev_err(dev, "unsupported hub number %d\n", upphub);
258 usbspd = USBSPD_SPEED_LOW;
261 usbspd = USBSPD_SPEED_FULL;
264 usbspd = USBSPD_SPEED_HIGH;
267 dev_err(dev, "unsupported speed %d\n", speed);
271 usbhs_write(priv, reg, UPPHUB(upphub) |
279 * interrupt functions
281 void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
283 u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
285 usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
291 static void usbhsc_set_buswait(struct usbhs_priv *priv)
293 int wait = usbhs_get_dparam(priv, buswait_bwait);
295 /* set bus wait if platform have */
297 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
301 * platform default param
304 /* commonly used on old SH-Mobile SoCs */
305 static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
306 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
307 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, false),
308 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
309 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
310 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
311 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
312 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
313 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
314 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
315 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
318 /* commonly used on newer SH-Mobile and R-Car SoCs */
319 static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
320 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
321 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
322 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
323 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
324 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
325 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
326 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
327 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
328 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
329 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
330 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
331 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
332 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
333 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
334 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
335 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
341 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
343 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
344 struct device *dev = usbhs_priv_to_dev(priv);
348 pm_runtime_get_sync(dev);
350 /* enable platform power */
351 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
354 usbhs_sys_clock_ctrl(priv, enable);
357 usbhs_sys_clock_ctrl(priv, enable);
359 /* disable platform power */
360 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
363 pm_runtime_put_sync(dev);
370 static void usbhsc_hotplug(struct usbhs_priv *priv)
372 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
373 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
380 * get vbus status from platform
382 enable = usbhs_platform_call(priv, get_vbus, pdev);
385 * get id from platform
387 id = usbhs_platform_call(priv, get_id, pdev);
389 if (enable && !mod) {
391 cable = extcon_get_cable_state_(priv->edev, EXTCON_USB_HOST);
392 if ((cable > 0 && id != USBHS_HOST) ||
393 (!cable && id != USBHS_GADGET)) {
395 "USB cable plugged in doesn't match the selected role!\n");
400 ret = usbhs_mod_change(priv, id);
404 dev_dbg(&pdev->dev, "%s enable\n", __func__);
407 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
408 usbhsc_power_ctrl(priv, enable);
411 usbhsc_set_buswait(priv);
412 usbhsc_bus_init(priv);
415 usbhs_mod_call(priv, start, priv);
417 } else if (!enable && mod) {
418 dev_dbg(&pdev->dev, "%s disable\n", __func__);
421 usbhs_mod_call(priv, stop, priv);
424 usbhsc_bus_init(priv);
427 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
428 usbhsc_power_ctrl(priv, enable);
430 usbhs_mod_change(priv, -1);
432 /* reset phy for next connection */
433 usbhs_platform_call(priv, phy_reset, pdev);
440 static void usbhsc_notify_hotplug(struct work_struct *work)
442 struct usbhs_priv *priv = container_of(work,
444 notify_hotplug_work.work);
445 usbhsc_hotplug(priv);
448 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
450 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
451 int delay = usbhs_get_dparam(priv, detection_delay);
454 * This functions will be called in interrupt.
455 * To make sure safety context,
456 * use workqueue for usbhs_notify_hotplug
458 schedule_delayed_work(&priv->notify_hotplug_work,
459 msecs_to_jiffies(delay));
466 static const struct of_device_id usbhs_of_match[] = {
468 .compatible = "renesas,usbhs-r8a7790",
469 .data = (void *)USBHS_TYPE_RCAR_GEN2,
472 .compatible = "renesas,usbhs-r8a7791",
473 .data = (void *)USBHS_TYPE_RCAR_GEN2,
476 .compatible = "renesas,usbhs-r8a7794",
477 .data = (void *)USBHS_TYPE_RCAR_GEN2,
480 /* Gen3 is compatible with Gen2 */
481 .compatible = "renesas,usbhs-r8a7795",
482 .data = (void *)USBHS_TYPE_RCAR_GEN2,
485 .compatible = "renesas,rcar-gen2-usbhs",
486 .data = (void *)USBHS_TYPE_RCAR_GEN2,
489 /* Gen3 is compatible with Gen2 */
490 .compatible = "renesas,rcar-gen3-usbhs",
491 .data = (void *)USBHS_TYPE_RCAR_GEN2,
495 MODULE_DEVICE_TABLE(of, usbhs_of_match);
497 static struct renesas_usbhs_platform_info *usbhs_parse_dt(struct device *dev)
499 struct renesas_usbhs_platform_info *info;
500 struct renesas_usbhs_driver_param *dparam;
501 const struct of_device_id *of_id = of_match_device(usbhs_of_match, dev);
505 info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
509 dparam = &info->driver_param;
510 dparam->type = of_id ? (uintptr_t)of_id->data : 0;
511 if (!of_property_read_u32(dev->of_node, "renesas,buswait", &tmp))
512 dparam->buswait_bwait = tmp;
513 gpio = of_get_named_gpio_flags(dev->of_node, "renesas,enable-gpio", 0,
516 dparam->enable_gpio = gpio;
518 if (dparam->type == USBHS_TYPE_RCAR_GEN2)
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);
582 if (!info->platform_callback.get_id) {
583 dev_err(&pdev->dev, "no platform callbacks");
587 &info->platform_callback,
588 sizeof(struct renesas_usbhs_platform_callback));
592 /* set driver callback functions for platform */
593 dfunc = &info->driver_callback;
594 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
596 /* set default param if platform doesn't have */
597 if (!priv->dparam.pipe_configs) {
598 priv->dparam.pipe_configs = usbhsc_default_pipe;
599 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
601 if (!priv->dparam.pio_dma_border)
602 priv->dparam.pio_dma_border = 64; /* 64byte */
605 /* runtime power control ? */
606 if (priv->pfunc.get_vbus)
607 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
612 priv->irq = irq_res->start;
613 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
614 priv->irqflags = IRQF_SHARED;
616 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
617 spin_lock_init(usbhs_priv_to_lock(priv));
619 /* call pipe and module init */
620 ret = usbhs_pipe_probe(priv);
624 ret = usbhs_fifo_probe(priv);
626 goto probe_end_pipe_exit;
628 ret = usbhs_mod_probe(priv);
630 goto probe_end_fifo_exit;
632 /* dev_set_drvdata should be called after usbhs_mod_init */
633 platform_set_drvdata(pdev, priv);
636 * deviece reset here because
637 * USB device might be used in boot loader.
639 usbhs_sys_clock_ctrl(priv, 0);
641 /* check GPIO determining if USB function should be enabled */
642 if (priv->dparam.enable_gpio) {
643 gpio_request_one(priv->dparam.enable_gpio, GPIOF_IN, NULL);
644 ret = !gpio_get_value(priv->dparam.enable_gpio);
645 gpio_free(priv->dparam.enable_gpio);
648 "USB function not selected (GPIO %d)\n",
649 priv->dparam.enable_gpio);
651 goto probe_end_mod_exit;
658 * USB phy setup might depend on CPU/Board.
659 * If platform has its callback functions,
662 ret = usbhs_platform_call(priv, hardware_init, pdev);
664 dev_err(&pdev->dev, "platform init failed.\n");
665 goto probe_end_mod_exit;
668 /* reset phy for connection */
669 usbhs_platform_call(priv, phy_reset, pdev);
672 pm_runtime_enable(&pdev->dev);
673 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
674 usbhsc_power_ctrl(priv, 1);
675 usbhs_mod_autonomy_mode(priv);
679 * manual call notify_hotplug for cold plug
681 usbhsc_drvcllbck_notify_hotplug(pdev);
683 dev_info(&pdev->dev, "probed\n");
688 usbhs_mod_remove(priv);
690 usbhs_fifo_remove(priv);
692 usbhs_pipe_remove(priv);
694 dev_info(&pdev->dev, "probe failed\n");
699 static int usbhs_remove(struct platform_device *pdev)
701 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
702 struct renesas_usbhs_platform_info *info = dev_get_platdata(&pdev->dev);
703 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
705 dev_dbg(&pdev->dev, "usb remove\n");
707 dfunc->notify_hotplug = NULL;
710 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
711 usbhsc_power_ctrl(priv, 0);
713 pm_runtime_disable(&pdev->dev);
715 usbhs_platform_call(priv, hardware_exit, pdev);
716 usbhs_mod_remove(priv);
717 usbhs_fifo_remove(priv);
718 usbhs_pipe_remove(priv);
723 static int usbhsc_suspend(struct device *dev)
725 struct usbhs_priv *priv = dev_get_drvdata(dev);
726 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
729 usbhs_mod_call(priv, stop, priv);
730 usbhs_mod_change(priv, -1);
733 if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
734 usbhsc_power_ctrl(priv, 0);
739 static int usbhsc_resume(struct device *dev)
741 struct usbhs_priv *priv = dev_get_drvdata(dev);
742 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
744 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
745 usbhsc_power_ctrl(priv, 1);
747 usbhs_platform_call(priv, phy_reset, pdev);
749 usbhsc_drvcllbck_notify_hotplug(pdev);
754 static int usbhsc_runtime_nop(struct device *dev)
756 /* Runtime PM callback shared between ->runtime_suspend()
757 * and ->runtime_resume(). Simply returns success.
759 * This driver re-initializes all registers after
760 * pm_runtime_get_sync() anyway so there is no need
761 * to save and restore registers here.
766 static const struct dev_pm_ops usbhsc_pm_ops = {
767 .suspend = usbhsc_suspend,
768 .resume = usbhsc_resume,
769 .runtime_suspend = usbhsc_runtime_nop,
770 .runtime_resume = usbhsc_runtime_nop,
773 static struct platform_driver renesas_usbhs_driver = {
775 .name = "renesas_usbhs",
776 .pm = &usbhsc_pm_ops,
777 .of_match_table = of_match_ptr(usbhs_of_match),
779 .probe = usbhs_probe,
780 .remove = usbhs_remove,
783 module_platform_driver(renesas_usbhs_driver);
785 MODULE_LICENSE("GPL");
786 MODULE_DESCRIPTION("Renesas USB driver");
787 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");