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>
14 #include <linux/of_device.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 void __dwc2_disable_regulators(void *data)
96 struct dwc2_hsotg *hsotg = data;
98 regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies), hsotg->supplies);
101 static int __dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
103 struct platform_device *pdev = to_platform_device(hsotg->dev);
106 ret = regulator_bulk_enable(ARRAY_SIZE(hsotg->supplies),
111 ret = devm_add_action_or_reset(&pdev->dev,
112 __dwc2_disable_regulators, hsotg);
117 ret = clk_prepare_enable(hsotg->clk);
123 ret = usb_phy_init(hsotg->uphy);
124 } else if (hsotg->plat && hsotg->plat->phy_init) {
125 ret = hsotg->plat->phy_init(pdev, hsotg->plat->phy_type);
127 ret = phy_init(hsotg->phy);
129 ret = phy_power_on(hsotg->phy);
136 * dwc2_lowlevel_hw_enable - enable platform lowlevel hw resources
137 * @hsotg: The driver state
139 * A wrapper for platform code responsible for controlling
140 * low-level USB platform resources (phy, clock, regulators)
142 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
144 int ret = __dwc2_lowlevel_hw_enable(hsotg);
147 hsotg->ll_hw_enabled = true;
151 static int __dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
153 struct platform_device *pdev = to_platform_device(hsotg->dev);
157 usb_phy_shutdown(hsotg->uphy);
158 } else if (hsotg->plat && hsotg->plat->phy_exit) {
159 ret = hsotg->plat->phy_exit(pdev, hsotg->plat->phy_type);
161 ret = phy_power_off(hsotg->phy);
163 ret = phy_exit(hsotg->phy);
169 clk_disable_unprepare(hsotg->clk);
175 * dwc2_lowlevel_hw_disable - disable platform lowlevel hw resources
176 * @hsotg: The driver state
178 * A wrapper for platform code responsible for controlling
179 * low-level USB platform resources (phy, clock, regulators)
181 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
183 int ret = __dwc2_lowlevel_hw_disable(hsotg);
186 hsotg->ll_hw_enabled = false;
190 static int dwc2_lowlevel_hw_init(struct dwc2_hsotg *hsotg)
194 hsotg->reset = devm_reset_control_get_optional(hsotg->dev, "dwc2");
195 if (IS_ERR(hsotg->reset))
196 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset),
197 "error getting reset control\n");
199 reset_control_deassert(hsotg->reset);
201 hsotg->reset_ecc = devm_reset_control_get_optional(hsotg->dev, "dwc2-ecc");
202 if (IS_ERR(hsotg->reset_ecc))
203 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset_ecc),
204 "error getting reset control for ecc\n");
206 reset_control_deassert(hsotg->reset_ecc);
209 * Attempt to find a generic PHY, then look for an old style
210 * USB PHY and then fall back to pdata
212 hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
213 if (IS_ERR(hsotg->phy)) {
214 ret = PTR_ERR(hsotg->phy);
221 return dev_err_probe(hsotg->dev, ret, "error getting phy\n");
226 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
227 if (IS_ERR(hsotg->uphy)) {
228 ret = PTR_ERR(hsotg->uphy);
235 return dev_err_probe(hsotg->dev, ret, "error getting usb phy\n");
240 hsotg->plat = dev_get_platdata(hsotg->dev);
243 hsotg->clk = devm_clk_get_optional(hsotg->dev, "otg");
244 if (IS_ERR(hsotg->clk))
245 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->clk), "cannot get otg clock\n");
248 for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
249 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
251 ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
254 return dev_err_probe(hsotg->dev, ret, "failed to request supplies\n");
260 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
263 * @dev: Platform device
265 * This routine is called, for example, when the rmmod command is executed. The
266 * device may or may not be electrically present. If it is present, the driver
267 * stops device processing. Any resources used on behalf of this device are
270 static int dwc2_driver_remove(struct platform_device *dev)
272 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
273 struct dwc2_gregs_backup *gr;
276 gr = &hsotg->gr_backup;
278 /* Exit Hibernation when driver is removed. */
279 if (hsotg->hibernated) {
280 if (gr->gotgctl & GOTGCTL_CURMODE_HOST)
281 ret = dwc2_exit_hibernation(hsotg, 0, 0, 1);
283 ret = dwc2_exit_hibernation(hsotg, 0, 0, 0);
287 "exit hibernation failed.\n");
290 /* Exit Partial Power Down when driver is removed. */
292 ret = dwc2_exit_partial_power_down(hsotg, 0, true);
295 "exit partial_power_down failed\n");
298 /* Exit clock gating when driver is removed. */
299 if (hsotg->params.power_down == DWC2_POWER_DOWN_PARAM_NONE &&
300 hsotg->bus_suspended) {
301 if (dwc2_is_device_mode(hsotg))
302 dwc2_gadget_exit_clock_gating(hsotg, 0);
304 dwc2_host_exit_clock_gating(hsotg, 0);
307 dwc2_debugfs_exit(hsotg);
308 if (hsotg->hcd_enabled)
309 dwc2_hcd_remove(hsotg);
310 if (hsotg->gadget_enabled)
311 dwc2_hsotg_remove(hsotg);
313 dwc2_drd_exit(hsotg);
315 if (hsotg->params.activate_stm_id_vb_detection)
316 regulator_disable(hsotg->usb33d);
318 if (hsotg->ll_hw_enabled)
319 dwc2_lowlevel_hw_disable(hsotg);
321 reset_control_assert(hsotg->reset);
322 reset_control_assert(hsotg->reset_ecc);
328 * dwc2_driver_shutdown() - Called on device shutdown
330 * @dev: Platform device
332 * In specific conditions (involving usb hubs) dwc2 devices can create a
333 * lot of interrupts, even to the point of overwhelming devices running
334 * at low frequencies. Some devices need to do special clock handling
335 * at shutdown-time which may bring the system clock below the threshold
336 * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
337 * prevents reboots/poweroffs from getting stuck in such cases.
339 static void dwc2_driver_shutdown(struct platform_device *dev)
341 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
343 dwc2_disable_global_interrupts(hsotg);
344 synchronize_irq(hsotg->irq);
348 * dwc2_check_core_endianness() - Returns true if core and AHB have
349 * opposite endianness.
350 * @hsotg: Programming view of the DWC_otg controller.
352 static bool dwc2_check_core_endianness(struct dwc2_hsotg *hsotg)
356 snpsid = ioread32(hsotg->regs + GSNPSID);
357 if ((snpsid & GSNPSID_ID_MASK) == DWC2_OTG_ID ||
358 (snpsid & GSNPSID_ID_MASK) == DWC2_FS_IOT_ID ||
359 (snpsid & GSNPSID_ID_MASK) == DWC2_HS_IOT_ID)
365 * dwc2_check_core_version() - Check core version
367 * @hsotg: Programming view of the DWC_otg controller
370 int dwc2_check_core_version(struct dwc2_hsotg *hsotg)
372 struct dwc2_hw_params *hw = &hsotg->hw_params;
375 * Attempt to ensure this device is really a DWC_otg Controller.
376 * Read and verify the GSNPSID register contents. The value should be
377 * 0x45f4xxxx, 0x5531xxxx or 0x5532xxxx
380 hw->snpsid = dwc2_readl(hsotg, GSNPSID);
381 if ((hw->snpsid & GSNPSID_ID_MASK) != DWC2_OTG_ID &&
382 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_FS_IOT_ID &&
383 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_HS_IOT_ID) {
384 dev_err(hsotg->dev, "Bad value for GSNPSID: 0x%08x\n",
389 dev_dbg(hsotg->dev, "Core Release: %1x.%1x%1x%1x (snpsid=%x)\n",
390 hw->snpsid >> 12 & 0xf, hw->snpsid >> 8 & 0xf,
391 hw->snpsid >> 4 & 0xf, hw->snpsid & 0xf, hw->snpsid);
396 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
399 * @dev: Platform device
401 * This routine creates the driver components required to control the device
402 * (core, HCD, and PCD) and initializes the device. The driver components are
403 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
404 * in the device private data. This allows the driver to access the dwc2_hsotg
405 * structure on subsequent calls to driver methods for this device.
407 static int dwc2_driver_probe(struct platform_device *dev)
409 struct dwc2_hsotg *hsotg;
410 struct resource *res;
413 hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
417 hsotg->dev = &dev->dev;
420 * Use reasonable defaults so platforms don't have to provide these.
422 if (!dev->dev.dma_mask)
423 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
424 retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
426 dev_err(&dev->dev, "can't set coherent DMA mask: %d\n", retval);
430 hsotg->regs = devm_platform_get_and_ioremap_resource(dev, 0, &res);
431 if (IS_ERR(hsotg->regs))
432 return PTR_ERR(hsotg->regs);
434 dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
435 (unsigned long)res->start, hsotg->regs);
437 retval = dwc2_lowlevel_hw_init(hsotg);
441 spin_lock_init(&hsotg->lock);
443 hsotg->irq = platform_get_irq(dev, 0);
447 dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
449 retval = devm_request_irq(hsotg->dev, hsotg->irq,
450 dwc2_handle_common_intr, IRQF_SHARED,
451 dev_name(hsotg->dev), hsotg);
455 hsotg->vbus_supply = devm_regulator_get_optional(hsotg->dev, "vbus");
456 if (IS_ERR(hsotg->vbus_supply)) {
457 retval = PTR_ERR(hsotg->vbus_supply);
458 hsotg->vbus_supply = NULL;
459 if (retval != -ENODEV)
463 retval = dwc2_lowlevel_hw_enable(hsotg);
467 hsotg->needs_byte_swap = dwc2_check_core_endianness(hsotg);
469 retval = dwc2_get_dr_mode(hsotg);
473 hsotg->need_phy_for_wake =
474 of_property_read_bool(dev->dev.of_node,
475 "snps,need-phy-for-wake");
478 * Before performing any core related operations
479 * check core version.
481 retval = dwc2_check_core_version(hsotg);
486 * Reset before dwc2_get_hwparams() then it could get power-on real
487 * reset value form registers.
489 retval = dwc2_core_reset(hsotg, false);
493 /* Detect config values from hardware */
494 retval = dwc2_get_hwparams(hsotg);
499 * For OTG cores, set the force mode bits to reflect the value
500 * of dr_mode. Force mode bits should not be touched at any
501 * other time after this.
503 dwc2_force_dr_mode(hsotg);
505 retval = dwc2_init_params(hsotg);
509 if (hsotg->params.activate_stm_id_vb_detection) {
512 hsotg->usb33d = devm_regulator_get(hsotg->dev, "usb33d");
513 if (IS_ERR(hsotg->usb33d)) {
514 retval = PTR_ERR(hsotg->usb33d);
515 dev_err_probe(hsotg->dev, retval, "failed to request usb33d supply\n");
518 retval = regulator_enable(hsotg->usb33d);
520 dev_err_probe(hsotg->dev, retval, "failed to enable usb33d supply\n");
524 ggpio = dwc2_readl(hsotg, GGPIO);
525 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
526 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
527 dwc2_writel(hsotg, ggpio, GGPIO);
529 /* ID/VBUS detection startup time */
530 usleep_range(5000, 7000);
533 retval = dwc2_drd_init(hsotg);
535 dev_err_probe(hsotg->dev, retval, "failed to initialize dual-role\n");
539 if (hsotg->dr_mode != USB_DR_MODE_HOST) {
540 retval = dwc2_gadget_init(hsotg);
543 hsotg->gadget_enabled = 1;
547 * If we need PHY for wakeup we must be wakeup capable.
548 * When we have a device that can wake without the PHY we
549 * can adjust this condition.
551 if (hsotg->need_phy_for_wake)
552 device_set_wakeup_capable(&dev->dev, true);
554 hsotg->reset_phy_on_wake =
555 of_property_read_bool(dev->dev.of_node,
556 "snps,reset-phy-on-wake");
557 if (hsotg->reset_phy_on_wake && !hsotg->phy) {
559 "Quirk reset-phy-on-wake only supports generic PHYs\n");
560 hsotg->reset_phy_on_wake = false;
563 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
564 retval = dwc2_hcd_init(hsotg);
566 if (hsotg->gadget_enabled)
567 dwc2_hsotg_remove(hsotg);
570 hsotg->hcd_enabled = 1;
573 platform_set_drvdata(dev, hsotg);
574 hsotg->hibernated = 0;
576 dwc2_debugfs_init(hsotg);
578 /* Gadget code manages lowlevel hw on its own */
579 if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL ||
580 (hsotg->dr_mode == USB_DR_MODE_OTG && dwc2_is_device_mode(hsotg)))
581 dwc2_lowlevel_hw_disable(hsotg);
583 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
584 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
585 /* Postponed adding a new gadget to the udc class driver list */
586 if (hsotg->gadget_enabled) {
587 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
589 hsotg->gadget.udc = NULL;
590 dwc2_hsotg_remove(hsotg);
594 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
597 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
598 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
600 dwc2_debugfs_exit(hsotg);
601 if (hsotg->hcd_enabled)
602 dwc2_hcd_remove(hsotg);
605 dwc2_drd_exit(hsotg);
608 if (hsotg->params.activate_stm_id_vb_detection)
609 regulator_disable(hsotg->usb33d);
611 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL)
612 dwc2_lowlevel_hw_disable(hsotg);
616 static int __maybe_unused dwc2_suspend(struct device *dev)
618 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
619 bool is_device_mode = dwc2_is_device_mode(dwc2);
623 dwc2_hsotg_suspend(dwc2);
625 dwc2_drd_suspend(dwc2);
627 if (dwc2->params.activate_stm_id_vb_detection) {
632 * Need to force the mode to the current mode to avoid Mode
633 * Mismatch Interrupt when ID detection will be disabled.
635 dwc2_force_mode(dwc2, !is_device_mode);
637 spin_lock_irqsave(&dwc2->lock, flags);
638 gotgctl = dwc2_readl(dwc2, GOTGCTL);
639 /* bypass debounce filter, enable overrides */
640 gotgctl |= GOTGCTL_DBNCE_FLTR_BYPASS;
641 gotgctl |= GOTGCTL_BVALOEN | GOTGCTL_AVALOEN;
642 /* Force A / B session if needed */
643 if (gotgctl & GOTGCTL_ASESVLD)
644 gotgctl |= GOTGCTL_AVALOVAL;
645 if (gotgctl & GOTGCTL_BSESVLD)
646 gotgctl |= GOTGCTL_BVALOVAL;
647 dwc2_writel(dwc2, gotgctl, GOTGCTL);
648 spin_unlock_irqrestore(&dwc2->lock, flags);
650 ggpio = dwc2_readl(dwc2, GGPIO);
651 ggpio &= ~GGPIO_STM32_OTG_GCCFG_IDEN;
652 ggpio &= ~GGPIO_STM32_OTG_GCCFG_VBDEN;
653 dwc2_writel(dwc2, ggpio, GGPIO);
655 regulator_disable(dwc2->usb33d);
658 if (dwc2->ll_hw_enabled &&
659 (is_device_mode || dwc2_host_can_poweroff_phy(dwc2))) {
660 ret = __dwc2_lowlevel_hw_disable(dwc2);
661 dwc2->phy_off_for_suspend = true;
667 static int __maybe_unused dwc2_resume(struct device *dev)
669 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
672 if (dwc2->phy_off_for_suspend && dwc2->ll_hw_enabled) {
673 ret = __dwc2_lowlevel_hw_enable(dwc2);
677 dwc2->phy_off_for_suspend = false;
679 if (dwc2->params.activate_stm_id_vb_detection) {
683 ret = regulator_enable(dwc2->usb33d);
687 ggpio = dwc2_readl(dwc2, GGPIO);
688 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
689 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
690 dwc2_writel(dwc2, ggpio, GGPIO);
692 /* ID/VBUS detection startup time */
693 usleep_range(5000, 7000);
695 spin_lock_irqsave(&dwc2->lock, flags);
696 gotgctl = dwc2_readl(dwc2, GOTGCTL);
697 gotgctl &= ~GOTGCTL_DBNCE_FLTR_BYPASS;
698 gotgctl &= ~(GOTGCTL_BVALOEN | GOTGCTL_AVALOEN |
699 GOTGCTL_BVALOVAL | GOTGCTL_AVALOVAL);
700 dwc2_writel(dwc2, gotgctl, GOTGCTL);
701 spin_unlock_irqrestore(&dwc2->lock, flags);
704 if (!dwc2->role_sw) {
705 /* Need to restore FORCEDEVMODE/FORCEHOSTMODE */
706 dwc2_force_dr_mode(dwc2);
708 dwc2_drd_resume(dwc2);
711 if (dwc2_is_device_mode(dwc2))
712 ret = dwc2_hsotg_resume(dwc2);
717 static const struct dev_pm_ops dwc2_dev_pm_ops = {
718 SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
721 static struct platform_driver dwc2_platform_driver = {
723 .name = dwc2_driver_name,
724 .of_match_table = dwc2_of_match_table,
725 .acpi_match_table = ACPI_PTR(dwc2_acpi_match),
726 .pm = &dwc2_dev_pm_ops,
728 .probe = dwc2_driver_probe,
729 .remove = dwc2_driver_remove,
730 .shutdown = dwc2_driver_shutdown,
733 module_platform_driver(dwc2_platform_driver);