1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
3 * platform.c - DesignWare HS OTG Controller platform driver
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/slab.h>
11 #include <linux/clk.h>
12 #include <linux/device.h>
13 #include <linux/dma-mapping.h>
15 #include <linux/mutex.h>
16 #include <linux/platform_device.h>
17 #include <linux/phy/phy.h>
18 #include <linux/platform_data/s3c-hsotg.h>
19 #include <linux/reset.h>
21 #include <linux/usb/of.h>
27 static const char dwc2_driver_name[] = "dwc2";
30 * Check the dr_mode against the module configuration and hardware
33 * The hardware, module, and dr_mode, can each be set to host, device,
34 * or otg. Check that all these values are compatible and adjust the
35 * value of dr_mode if possible.
38 * HW MOD dr_mode dr_mode
39 * ------------------------------
50 * OTG OTG any : dr_mode
52 static int dwc2_get_dr_mode(struct dwc2_hsotg *hsotg)
54 enum usb_dr_mode mode;
56 hsotg->dr_mode = usb_get_dr_mode(hsotg->dev);
57 if (hsotg->dr_mode == USB_DR_MODE_UNKNOWN)
58 hsotg->dr_mode = USB_DR_MODE_OTG;
60 mode = hsotg->dr_mode;
62 if (dwc2_hw_is_device(hsotg)) {
63 if (IS_ENABLED(CONFIG_USB_DWC2_HOST)) {
65 "Controller does not support host mode.\n");
68 mode = USB_DR_MODE_PERIPHERAL;
69 } else if (dwc2_hw_is_host(hsotg)) {
70 if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL)) {
72 "Controller does not support device mode.\n");
75 mode = USB_DR_MODE_HOST;
77 if (IS_ENABLED(CONFIG_USB_DWC2_HOST))
78 mode = USB_DR_MODE_HOST;
79 else if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL))
80 mode = USB_DR_MODE_PERIPHERAL;
83 if (mode != hsotg->dr_mode) {
85 "Configuration mismatch. dr_mode forced to %s\n",
86 mode == USB_DR_MODE_HOST ? "host" : "device");
88 hsotg->dr_mode = mode;
94 static int __dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
96 struct platform_device *pdev = to_platform_device(hsotg->dev);
99 ret = regulator_bulk_enable(ARRAY_SIZE(hsotg->supplies),
104 if (hsotg->utmi_clk) {
105 ret = clk_prepare_enable(hsotg->utmi_clk);
111 ret = clk_prepare_enable(hsotg->clk);
113 goto err_dis_utmi_clk;
117 ret = usb_phy_init(hsotg->uphy);
118 } else if (hsotg->plat && hsotg->plat->phy_init) {
119 ret = hsotg->plat->phy_init(pdev, hsotg->plat->phy_type);
121 ret = phy_init(hsotg->phy);
123 ret = phy_power_on(hsotg->phy);
125 phy_exit(hsotg->phy);
136 clk_disable_unprepare(hsotg->clk);
140 clk_disable_unprepare(hsotg->utmi_clk);
143 regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies), hsotg->supplies);
149 * dwc2_lowlevel_hw_enable - enable platform lowlevel hw resources
150 * @hsotg: The driver state
152 * A wrapper for platform code responsible for controlling
153 * low-level USB platform resources (phy, clock, regulators)
155 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
157 int ret = __dwc2_lowlevel_hw_enable(hsotg);
160 hsotg->ll_hw_enabled = true;
164 static int __dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
166 struct platform_device *pdev = to_platform_device(hsotg->dev);
170 usb_phy_shutdown(hsotg->uphy);
171 } else if (hsotg->plat && hsotg->plat->phy_exit) {
172 ret = hsotg->plat->phy_exit(pdev, hsotg->plat->phy_type);
174 ret = phy_power_off(hsotg->phy);
176 ret = phy_exit(hsotg->phy);
182 clk_disable_unprepare(hsotg->clk);
185 clk_disable_unprepare(hsotg->utmi_clk);
187 return regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies), hsotg->supplies);
191 * dwc2_lowlevel_hw_disable - disable platform lowlevel hw resources
192 * @hsotg: The driver state
194 * A wrapper for platform code responsible for controlling
195 * low-level USB platform resources (phy, clock, regulators)
197 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
199 int ret = __dwc2_lowlevel_hw_disable(hsotg);
202 hsotg->ll_hw_enabled = false;
206 static void dwc2_reset_control_assert(void *data)
208 reset_control_assert(data);
211 static int dwc2_lowlevel_hw_init(struct dwc2_hsotg *hsotg)
215 hsotg->reset = devm_reset_control_get_optional(hsotg->dev, "dwc2");
216 if (IS_ERR(hsotg->reset))
217 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset),
218 "error getting reset control\n");
220 reset_control_deassert(hsotg->reset);
221 ret = devm_add_action_or_reset(hsotg->dev, dwc2_reset_control_assert,
226 hsotg->reset_ecc = devm_reset_control_get_optional(hsotg->dev, "dwc2-ecc");
227 if (IS_ERR(hsotg->reset_ecc))
228 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset_ecc),
229 "error getting reset control for ecc\n");
231 reset_control_deassert(hsotg->reset_ecc);
232 ret = devm_add_action_or_reset(hsotg->dev, dwc2_reset_control_assert,
238 * Attempt to find a generic PHY, then look for an old style
239 * USB PHY and then fall back to pdata
241 hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
242 if (IS_ERR(hsotg->phy)) {
243 ret = PTR_ERR(hsotg->phy);
250 return dev_err_probe(hsotg->dev, ret, "error getting phy\n");
255 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
256 if (IS_ERR(hsotg->uphy)) {
257 ret = PTR_ERR(hsotg->uphy);
264 return dev_err_probe(hsotg->dev, ret, "error getting usb phy\n");
269 hsotg->plat = dev_get_platdata(hsotg->dev);
272 hsotg->clk = devm_clk_get_optional(hsotg->dev, "otg");
273 if (IS_ERR(hsotg->clk))
274 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->clk), "cannot get otg clock\n");
276 hsotg->utmi_clk = devm_clk_get_optional(hsotg->dev, "utmi");
277 if (IS_ERR(hsotg->utmi_clk))
278 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->utmi_clk),
279 "cannot get utmi clock\n");
282 for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
283 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
285 ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
288 return dev_err_probe(hsotg->dev, ret, "failed to request supplies\n");
294 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
297 * @dev: Platform device
299 * This routine is called, for example, when the rmmod command is executed. The
300 * device may or may not be electrically present. If it is present, the driver
301 * stops device processing. Any resources used on behalf of this device are
304 static void dwc2_driver_remove(struct platform_device *dev)
306 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
307 struct dwc2_gregs_backup *gr;
310 gr = &hsotg->gr_backup;
312 /* Exit Hibernation when driver is removed. */
313 if (hsotg->hibernated) {
314 if (gr->gotgctl & GOTGCTL_CURMODE_HOST)
315 ret = dwc2_exit_hibernation(hsotg, 0, 0, 1);
317 ret = dwc2_exit_hibernation(hsotg, 0, 0, 0);
321 "exit hibernation failed.\n");
324 /* Exit Partial Power Down when driver is removed. */
326 ret = dwc2_exit_partial_power_down(hsotg, 0, true);
329 "exit partial_power_down failed\n");
332 /* Exit clock gating when driver is removed. */
333 if (hsotg->params.power_down == DWC2_POWER_DOWN_PARAM_NONE &&
334 hsotg->bus_suspended && !hsotg->params.no_clock_gating) {
335 if (dwc2_is_device_mode(hsotg))
336 dwc2_gadget_exit_clock_gating(hsotg, 0);
338 dwc2_host_exit_clock_gating(hsotg, 0);
341 dwc2_debugfs_exit(hsotg);
342 if (hsotg->hcd_enabled)
343 dwc2_hcd_remove(hsotg);
344 if (hsotg->gadget_enabled)
345 dwc2_hsotg_remove(hsotg);
347 dwc2_drd_exit(hsotg);
349 if (hsotg->params.activate_stm_id_vb_detection)
350 regulator_disable(hsotg->usb33d);
352 if (hsotg->ll_hw_enabled)
353 dwc2_lowlevel_hw_disable(hsotg);
357 * dwc2_driver_shutdown() - Called on device shutdown
359 * @dev: Platform device
361 * In specific conditions (involving usb hubs) dwc2 devices can create a
362 * lot of interrupts, even to the point of overwhelming devices running
363 * at low frequencies. Some devices need to do special clock handling
364 * at shutdown-time which may bring the system clock below the threshold
365 * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
366 * prevents reboots/poweroffs from getting stuck in such cases.
368 static void dwc2_driver_shutdown(struct platform_device *dev)
370 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
372 dwc2_disable_global_interrupts(hsotg);
373 synchronize_irq(hsotg->irq);
377 * dwc2_check_core_endianness() - Returns true if core and AHB have
378 * opposite endianness.
379 * @hsotg: Programming view of the DWC_otg controller.
381 static bool dwc2_check_core_endianness(struct dwc2_hsotg *hsotg)
385 snpsid = ioread32(hsotg->regs + GSNPSID);
386 if ((snpsid & GSNPSID_ID_MASK) == DWC2_OTG_ID ||
387 (snpsid & GSNPSID_ID_MASK) == DWC2_FS_IOT_ID ||
388 (snpsid & GSNPSID_ID_MASK) == DWC2_HS_IOT_ID)
394 * dwc2_check_core_version() - Check core version
396 * @hsotg: Programming view of the DWC_otg controller
399 int dwc2_check_core_version(struct dwc2_hsotg *hsotg)
401 struct dwc2_hw_params *hw = &hsotg->hw_params;
404 * Attempt to ensure this device is really a DWC_otg Controller.
405 * Read and verify the GSNPSID register contents. The value should be
406 * 0x45f4xxxx, 0x5531xxxx or 0x5532xxxx
409 hw->snpsid = dwc2_readl(hsotg, GSNPSID);
410 if ((hw->snpsid & GSNPSID_ID_MASK) != DWC2_OTG_ID &&
411 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_FS_IOT_ID &&
412 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_HS_IOT_ID) {
413 dev_err(hsotg->dev, "Bad value for GSNPSID: 0x%08x\n",
418 dev_dbg(hsotg->dev, "Core Release: %1x.%1x%1x%1x (snpsid=%x)\n",
419 hw->snpsid >> 12 & 0xf, hw->snpsid >> 8 & 0xf,
420 hw->snpsid >> 4 & 0xf, hw->snpsid & 0xf, hw->snpsid);
425 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
428 * @dev: Platform device
430 * This routine creates the driver components required to control the device
431 * (core, HCD, and PCD) and initializes the device. The driver components are
432 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
433 * in the device private data. This allows the driver to access the dwc2_hsotg
434 * structure on subsequent calls to driver methods for this device.
436 static int dwc2_driver_probe(struct platform_device *dev)
438 struct dwc2_hsotg *hsotg;
439 struct resource *res;
442 hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
446 hsotg->dev = &dev->dev;
449 * Use reasonable defaults so platforms don't have to provide these.
451 if (!dev->dev.dma_mask)
452 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
453 retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
455 dev_err(&dev->dev, "can't set coherent DMA mask: %d\n", retval);
459 hsotg->regs = devm_platform_get_and_ioremap_resource(dev, 0, &res);
460 if (IS_ERR(hsotg->regs))
461 return PTR_ERR(hsotg->regs);
463 dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
464 (unsigned long)res->start, hsotg->regs);
466 retval = dwc2_lowlevel_hw_init(hsotg);
470 spin_lock_init(&hsotg->lock);
472 hsotg->vbus_supply = devm_regulator_get_optional(hsotg->dev, "vbus");
473 if (IS_ERR(hsotg->vbus_supply)) {
474 retval = PTR_ERR(hsotg->vbus_supply);
475 hsotg->vbus_supply = NULL;
476 if (retval != -ENODEV)
480 retval = dwc2_lowlevel_hw_enable(hsotg);
484 hsotg->needs_byte_swap = dwc2_check_core_endianness(hsotg);
486 retval = dwc2_get_dr_mode(hsotg);
490 hsotg->need_phy_for_wake =
491 of_property_read_bool(dev->dev.of_node,
492 "snps,need-phy-for-wake");
495 * Before performing any core related operations
496 * check core version.
498 retval = dwc2_check_core_version(hsotg);
503 * Reset before dwc2_get_hwparams() then it could get power-on real
504 * reset value form registers.
506 retval = dwc2_core_reset(hsotg, false);
510 /* Detect config values from hardware */
511 retval = dwc2_get_hwparams(hsotg);
515 hsotg->irq = platform_get_irq(dev, 0);
516 if (hsotg->irq < 0) {
521 dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
523 retval = devm_request_irq(hsotg->dev, hsotg->irq,
524 dwc2_handle_common_intr, IRQF_SHARED,
525 dev_name(hsotg->dev), hsotg);
530 * For OTG cores, set the force mode bits to reflect the value
531 * of dr_mode. Force mode bits should not be touched at any
532 * other time after this.
534 dwc2_force_dr_mode(hsotg);
536 retval = dwc2_init_params(hsotg);
540 if (hsotg->params.activate_stm_id_vb_detection) {
543 hsotg->usb33d = devm_regulator_get(hsotg->dev, "usb33d");
544 if (IS_ERR(hsotg->usb33d)) {
545 retval = PTR_ERR(hsotg->usb33d);
546 dev_err_probe(hsotg->dev, retval, "failed to request usb33d supply\n");
549 retval = regulator_enable(hsotg->usb33d);
551 dev_err_probe(hsotg->dev, retval, "failed to enable usb33d supply\n");
555 ggpio = dwc2_readl(hsotg, GGPIO);
556 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
557 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
558 dwc2_writel(hsotg, ggpio, GGPIO);
560 /* ID/VBUS detection startup time */
561 usleep_range(5000, 7000);
564 retval = dwc2_drd_init(hsotg);
566 dev_err_probe(hsotg->dev, retval, "failed to initialize dual-role\n");
570 if (hsotg->dr_mode != USB_DR_MODE_HOST) {
571 retval = dwc2_gadget_init(hsotg);
574 hsotg->gadget_enabled = 1;
578 * If we need PHY for wakeup we must be wakeup capable.
579 * When we have a device that can wake without the PHY we
580 * can adjust this condition.
582 if (hsotg->need_phy_for_wake)
583 device_set_wakeup_capable(&dev->dev, true);
585 hsotg->reset_phy_on_wake =
586 of_property_read_bool(dev->dev.of_node,
587 "snps,reset-phy-on-wake");
588 if (hsotg->reset_phy_on_wake && !hsotg->phy) {
590 "Quirk reset-phy-on-wake only supports generic PHYs\n");
591 hsotg->reset_phy_on_wake = false;
594 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
595 retval = dwc2_hcd_init(hsotg);
597 if (hsotg->gadget_enabled)
598 dwc2_hsotg_remove(hsotg);
601 hsotg->hcd_enabled = 1;
604 platform_set_drvdata(dev, hsotg);
605 hsotg->hibernated = 0;
607 dwc2_debugfs_init(hsotg);
609 /* Gadget code manages lowlevel hw on its own */
610 if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL)
611 dwc2_lowlevel_hw_disable(hsotg);
613 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
614 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
615 /* Postponed adding a new gadget to the udc class driver list */
616 if (hsotg->gadget_enabled) {
617 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
619 hsotg->gadget.udc = NULL;
620 dwc2_hsotg_remove(hsotg);
624 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
627 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
628 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
630 dwc2_debugfs_exit(hsotg);
631 if (hsotg->hcd_enabled)
632 dwc2_hcd_remove(hsotg);
635 dwc2_drd_exit(hsotg);
638 if (hsotg->params.activate_stm_id_vb_detection)
639 regulator_disable(hsotg->usb33d);
641 if (hsotg->ll_hw_enabled)
642 dwc2_lowlevel_hw_disable(hsotg);
646 static int __maybe_unused dwc2_suspend(struct device *dev)
648 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
649 bool is_device_mode = dwc2_is_device_mode(dwc2);
653 dwc2_hsotg_suspend(dwc2);
655 dwc2_drd_suspend(dwc2);
657 if (dwc2->params.activate_stm_id_vb_detection) {
662 * Need to force the mode to the current mode to avoid Mode
663 * Mismatch Interrupt when ID detection will be disabled.
665 dwc2_force_mode(dwc2, !is_device_mode);
667 spin_lock_irqsave(&dwc2->lock, flags);
668 gotgctl = dwc2_readl(dwc2, GOTGCTL);
669 /* bypass debounce filter, enable overrides */
670 gotgctl |= GOTGCTL_DBNCE_FLTR_BYPASS;
671 gotgctl |= GOTGCTL_BVALOEN | GOTGCTL_AVALOEN;
672 /* Force A / B session if needed */
673 if (gotgctl & GOTGCTL_ASESVLD)
674 gotgctl |= GOTGCTL_AVALOVAL;
675 if (gotgctl & GOTGCTL_BSESVLD)
676 gotgctl |= GOTGCTL_BVALOVAL;
677 dwc2_writel(dwc2, gotgctl, GOTGCTL);
678 spin_unlock_irqrestore(&dwc2->lock, flags);
680 ggpio = dwc2_readl(dwc2, GGPIO);
681 ggpio &= ~GGPIO_STM32_OTG_GCCFG_IDEN;
682 ggpio &= ~GGPIO_STM32_OTG_GCCFG_VBDEN;
683 dwc2_writel(dwc2, ggpio, GGPIO);
685 regulator_disable(dwc2->usb33d);
688 if (dwc2->ll_hw_enabled &&
689 (is_device_mode || dwc2_host_can_poweroff_phy(dwc2))) {
690 ret = __dwc2_lowlevel_hw_disable(dwc2);
691 dwc2->phy_off_for_suspend = true;
697 static int __maybe_unused dwc2_resume(struct device *dev)
699 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
702 if (dwc2->phy_off_for_suspend && dwc2->ll_hw_enabled) {
703 ret = __dwc2_lowlevel_hw_enable(dwc2);
707 dwc2->phy_off_for_suspend = false;
709 if (dwc2->params.activate_stm_id_vb_detection) {
713 ret = regulator_enable(dwc2->usb33d);
717 ggpio = dwc2_readl(dwc2, GGPIO);
718 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
719 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
720 dwc2_writel(dwc2, ggpio, GGPIO);
722 /* ID/VBUS detection startup time */
723 usleep_range(5000, 7000);
725 spin_lock_irqsave(&dwc2->lock, flags);
726 gotgctl = dwc2_readl(dwc2, GOTGCTL);
727 gotgctl &= ~GOTGCTL_DBNCE_FLTR_BYPASS;
728 gotgctl &= ~(GOTGCTL_BVALOEN | GOTGCTL_AVALOEN |
729 GOTGCTL_BVALOVAL | GOTGCTL_AVALOVAL);
730 dwc2_writel(dwc2, gotgctl, GOTGCTL);
731 spin_unlock_irqrestore(&dwc2->lock, flags);
734 if (!dwc2->role_sw) {
735 /* Need to restore FORCEDEVMODE/FORCEHOSTMODE */
736 dwc2_force_dr_mode(dwc2);
738 dwc2_drd_resume(dwc2);
741 if (dwc2_is_device_mode(dwc2))
742 ret = dwc2_hsotg_resume(dwc2);
747 static const struct dev_pm_ops dwc2_dev_pm_ops = {
748 SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
751 static struct platform_driver dwc2_platform_driver = {
753 .name = dwc2_driver_name,
754 .of_match_table = dwc2_of_match_table,
755 .acpi_match_table = ACPI_PTR(dwc2_acpi_match),
756 .pm = &dwc2_dev_pm_ops,
758 .probe = dwc2_driver_probe,
759 .remove_new = dwc2_driver_remove,
760 .shutdown = dwc2_driver_shutdown,
763 module_platform_driver(dwc2_platform_driver);