1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
3 * platform.c - DesignWare HS OTG Controller platform driver
5 * Copyright (C) Matthijs Kooijman <matthijs@stdin.nl>
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 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),
105 ret = clk_prepare_enable(hsotg->clk);
111 ret = usb_phy_init(hsotg->uphy);
112 } else if (hsotg->plat && hsotg->plat->phy_init) {
113 ret = hsotg->plat->phy_init(pdev, hsotg->plat->phy_type);
115 ret = phy_init(hsotg->phy);
117 ret = phy_power_on(hsotg->phy);
124 * dwc2_lowlevel_hw_enable - enable platform lowlevel hw resources
125 * @hsotg: The driver state
127 * A wrapper for platform code responsible for controlling
128 * low-level USB platform resources (phy, clock, regulators)
130 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
132 int ret = __dwc2_lowlevel_hw_enable(hsotg);
135 hsotg->ll_hw_enabled = true;
139 static int __dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
141 struct platform_device *pdev = to_platform_device(hsotg->dev);
145 usb_phy_shutdown(hsotg->uphy);
146 } else if (hsotg->plat && hsotg->plat->phy_exit) {
147 ret = hsotg->plat->phy_exit(pdev, hsotg->plat->phy_type);
149 ret = phy_power_off(hsotg->phy);
151 ret = phy_exit(hsotg->phy);
157 clk_disable_unprepare(hsotg->clk);
159 return regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies), hsotg->supplies);
163 * dwc2_lowlevel_hw_disable - disable platform lowlevel hw resources
164 * @hsotg: The driver state
166 * A wrapper for platform code responsible for controlling
167 * low-level USB platform resources (phy, clock, regulators)
169 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
171 int ret = __dwc2_lowlevel_hw_disable(hsotg);
174 hsotg->ll_hw_enabled = false;
178 static int dwc2_lowlevel_hw_init(struct dwc2_hsotg *hsotg)
182 hsotg->reset = devm_reset_control_get_optional(hsotg->dev, "dwc2");
183 if (IS_ERR(hsotg->reset))
184 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset),
185 "error getting reset control\n");
187 reset_control_deassert(hsotg->reset);
189 hsotg->reset_ecc = devm_reset_control_get_optional(hsotg->dev, "dwc2-ecc");
190 if (IS_ERR(hsotg->reset_ecc))
191 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset_ecc),
192 "error getting reset control for ecc\n");
194 reset_control_deassert(hsotg->reset_ecc);
197 * Attempt to find a generic PHY, then look for an old style
198 * USB PHY and then fall back to pdata
200 hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
201 if (IS_ERR(hsotg->phy)) {
202 ret = PTR_ERR(hsotg->phy);
209 return dev_err_probe(hsotg->dev, ret, "error getting phy\n");
214 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
215 if (IS_ERR(hsotg->uphy)) {
216 ret = PTR_ERR(hsotg->uphy);
223 return dev_err_probe(hsotg->dev, ret, "error getting usb phy\n");
228 hsotg->plat = dev_get_platdata(hsotg->dev);
231 hsotg->clk = devm_clk_get_optional(hsotg->dev, "otg");
232 if (IS_ERR(hsotg->clk))
233 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->clk), "cannot get otg clock\n");
236 for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
237 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
239 ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
242 return dev_err_probe(hsotg->dev, ret, "failed to request supplies\n");
248 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
251 * @dev: Platform device
253 * This routine is called, for example, when the rmmod command is executed. The
254 * device may or may not be electrically present. If it is present, the driver
255 * stops device processing. Any resources used on behalf of this device are
258 static int dwc2_driver_remove(struct platform_device *dev)
260 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
261 struct dwc2_gregs_backup *gr;
264 gr = &hsotg->gr_backup;
266 /* Exit Hibernation when driver is removed. */
267 if (hsotg->hibernated) {
268 if (gr->gotgctl & GOTGCTL_CURMODE_HOST)
269 ret = dwc2_exit_hibernation(hsotg, 0, 0, 1);
271 ret = dwc2_exit_hibernation(hsotg, 0, 0, 0);
275 "exit hibernation failed.\n");
278 /* Exit Partial Power Down when driver is removed. */
280 ret = dwc2_exit_partial_power_down(hsotg, 0, true);
283 "exit partial_power_down failed\n");
286 /* Exit clock gating when driver is removed. */
287 if (hsotg->params.power_down == DWC2_POWER_DOWN_PARAM_NONE &&
288 hsotg->bus_suspended) {
289 if (dwc2_is_device_mode(hsotg))
290 dwc2_gadget_exit_clock_gating(hsotg, 0);
292 dwc2_host_exit_clock_gating(hsotg, 0);
295 dwc2_debugfs_exit(hsotg);
296 if (hsotg->hcd_enabled)
297 dwc2_hcd_remove(hsotg);
298 if (hsotg->gadget_enabled)
299 dwc2_hsotg_remove(hsotg);
301 dwc2_drd_exit(hsotg);
303 if (hsotg->params.activate_stm_id_vb_detection)
304 regulator_disable(hsotg->usb33d);
306 if (hsotg->ll_hw_enabled)
307 dwc2_lowlevel_hw_disable(hsotg);
309 reset_control_assert(hsotg->reset);
310 reset_control_assert(hsotg->reset_ecc);
316 * dwc2_driver_shutdown() - Called on device shutdown
318 * @dev: Platform device
320 * In specific conditions (involving usb hubs) dwc2 devices can create a
321 * lot of interrupts, even to the point of overwhelming devices running
322 * at low frequencies. Some devices need to do special clock handling
323 * at shutdown-time which may bring the system clock below the threshold
324 * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
325 * prevents reboots/poweroffs from getting stuck in such cases.
327 static void dwc2_driver_shutdown(struct platform_device *dev)
329 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
331 dwc2_disable_global_interrupts(hsotg);
332 synchronize_irq(hsotg->irq);
336 * dwc2_check_core_endianness() - Returns true if core and AHB have
337 * opposite endianness.
338 * @hsotg: Programming view of the DWC_otg controller.
340 static bool dwc2_check_core_endianness(struct dwc2_hsotg *hsotg)
344 snpsid = ioread32(hsotg->regs + GSNPSID);
345 if ((snpsid & GSNPSID_ID_MASK) == DWC2_OTG_ID ||
346 (snpsid & GSNPSID_ID_MASK) == DWC2_FS_IOT_ID ||
347 (snpsid & GSNPSID_ID_MASK) == DWC2_HS_IOT_ID)
353 * dwc2_check_core_version() - Check core version
355 * @hsotg: Programming view of the DWC_otg controller
358 int dwc2_check_core_version(struct dwc2_hsotg *hsotg)
360 struct dwc2_hw_params *hw = &hsotg->hw_params;
363 * Attempt to ensure this device is really a DWC_otg Controller.
364 * Read and verify the GSNPSID register contents. The value should be
365 * 0x45f4xxxx, 0x5531xxxx or 0x5532xxxx
368 hw->snpsid = dwc2_readl(hsotg, GSNPSID);
369 if ((hw->snpsid & GSNPSID_ID_MASK) != DWC2_OTG_ID &&
370 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_FS_IOT_ID &&
371 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_HS_IOT_ID) {
372 dev_err(hsotg->dev, "Bad value for GSNPSID: 0x%08x\n",
377 dev_dbg(hsotg->dev, "Core Release: %1x.%1x%1x%1x (snpsid=%x)\n",
378 hw->snpsid >> 12 & 0xf, hw->snpsid >> 8 & 0xf,
379 hw->snpsid >> 4 & 0xf, hw->snpsid & 0xf, hw->snpsid);
384 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
387 * @dev: Platform device
389 * This routine creates the driver components required to control the device
390 * (core, HCD, and PCD) and initializes the device. The driver components are
391 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
392 * in the device private data. This allows the driver to access the dwc2_hsotg
393 * structure on subsequent calls to driver methods for this device.
395 static int dwc2_driver_probe(struct platform_device *dev)
397 struct dwc2_hsotg *hsotg;
398 struct resource *res;
401 hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
405 hsotg->dev = &dev->dev;
408 * Use reasonable defaults so platforms don't have to provide these.
410 if (!dev->dev.dma_mask)
411 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
412 retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
414 dev_err(&dev->dev, "can't set coherent DMA mask: %d\n", retval);
418 hsotg->regs = devm_platform_get_and_ioremap_resource(dev, 0, &res);
419 if (IS_ERR(hsotg->regs))
420 return PTR_ERR(hsotg->regs);
422 dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
423 (unsigned long)res->start, hsotg->regs);
425 retval = dwc2_lowlevel_hw_init(hsotg);
429 spin_lock_init(&hsotg->lock);
431 hsotg->irq = platform_get_irq(dev, 0);
435 dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
437 retval = devm_request_irq(hsotg->dev, hsotg->irq,
438 dwc2_handle_common_intr, IRQF_SHARED,
439 dev_name(hsotg->dev), hsotg);
443 hsotg->vbus_supply = devm_regulator_get_optional(hsotg->dev, "vbus");
444 if (IS_ERR(hsotg->vbus_supply)) {
445 retval = PTR_ERR(hsotg->vbus_supply);
446 hsotg->vbus_supply = NULL;
447 if (retval != -ENODEV)
451 retval = dwc2_lowlevel_hw_enable(hsotg);
455 hsotg->needs_byte_swap = dwc2_check_core_endianness(hsotg);
457 retval = dwc2_get_dr_mode(hsotg);
461 hsotg->need_phy_for_wake =
462 of_property_read_bool(dev->dev.of_node,
463 "snps,need-phy-for-wake");
466 * Before performing any core related operations
467 * check core version.
469 retval = dwc2_check_core_version(hsotg);
474 * Reset before dwc2_get_hwparams() then it could get power-on real
475 * reset value form registers.
477 retval = dwc2_core_reset(hsotg, false);
481 /* Detect config values from hardware */
482 retval = dwc2_get_hwparams(hsotg);
487 * For OTG cores, set the force mode bits to reflect the value
488 * of dr_mode. Force mode bits should not be touched at any
489 * other time after this.
491 dwc2_force_dr_mode(hsotg);
493 retval = dwc2_init_params(hsotg);
497 if (hsotg->params.activate_stm_id_vb_detection) {
500 hsotg->usb33d = devm_regulator_get(hsotg->dev, "usb33d");
501 if (IS_ERR(hsotg->usb33d)) {
502 retval = PTR_ERR(hsotg->usb33d);
503 dev_err_probe(hsotg->dev, retval, "failed to request usb33d supply\n");
506 retval = regulator_enable(hsotg->usb33d);
508 dev_err_probe(hsotg->dev, retval, "failed to enable usb33d supply\n");
512 ggpio = dwc2_readl(hsotg, GGPIO);
513 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
514 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
515 dwc2_writel(hsotg, ggpio, GGPIO);
517 /* ID/VBUS detection startup time */
518 usleep_range(5000, 7000);
521 retval = dwc2_drd_init(hsotg);
523 dev_err_probe(hsotg->dev, retval, "failed to initialize dual-role\n");
527 if (hsotg->dr_mode != USB_DR_MODE_HOST) {
528 retval = dwc2_gadget_init(hsotg);
531 hsotg->gadget_enabled = 1;
535 * If we need PHY for wakeup we must be wakeup capable.
536 * When we have a device that can wake without the PHY we
537 * can adjust this condition.
539 if (hsotg->need_phy_for_wake)
540 device_set_wakeup_capable(&dev->dev, true);
542 hsotg->reset_phy_on_wake =
543 of_property_read_bool(dev->dev.of_node,
544 "snps,reset-phy-on-wake");
545 if (hsotg->reset_phy_on_wake && !hsotg->phy) {
547 "Quirk reset-phy-on-wake only supports generic PHYs\n");
548 hsotg->reset_phy_on_wake = false;
551 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
552 retval = dwc2_hcd_init(hsotg);
554 if (hsotg->gadget_enabled)
555 dwc2_hsotg_remove(hsotg);
558 hsotg->hcd_enabled = 1;
561 platform_set_drvdata(dev, hsotg);
562 hsotg->hibernated = 0;
564 dwc2_debugfs_init(hsotg);
566 /* Gadget code manages lowlevel hw on its own */
567 if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL)
568 dwc2_lowlevel_hw_disable(hsotg);
570 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
571 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
572 /* Postponed adding a new gadget to the udc class driver list */
573 if (hsotg->gadget_enabled) {
574 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
576 hsotg->gadget.udc = NULL;
577 dwc2_hsotg_remove(hsotg);
581 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
584 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
585 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
587 dwc2_debugfs_exit(hsotg);
588 if (hsotg->hcd_enabled)
589 dwc2_hcd_remove(hsotg);
592 dwc2_drd_exit(hsotg);
595 if (hsotg->params.activate_stm_id_vb_detection)
596 regulator_disable(hsotg->usb33d);
598 if (hsotg->ll_hw_enabled)
599 dwc2_lowlevel_hw_disable(hsotg);
603 static int __maybe_unused dwc2_suspend(struct device *dev)
605 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
606 bool is_device_mode = dwc2_is_device_mode(dwc2);
610 dwc2_hsotg_suspend(dwc2);
612 dwc2_drd_suspend(dwc2);
614 if (dwc2->params.activate_stm_id_vb_detection) {
619 * Need to force the mode to the current mode to avoid Mode
620 * Mismatch Interrupt when ID detection will be disabled.
622 dwc2_force_mode(dwc2, !is_device_mode);
624 spin_lock_irqsave(&dwc2->lock, flags);
625 gotgctl = dwc2_readl(dwc2, GOTGCTL);
626 /* bypass debounce filter, enable overrides */
627 gotgctl |= GOTGCTL_DBNCE_FLTR_BYPASS;
628 gotgctl |= GOTGCTL_BVALOEN | GOTGCTL_AVALOEN;
629 /* Force A / B session if needed */
630 if (gotgctl & GOTGCTL_ASESVLD)
631 gotgctl |= GOTGCTL_AVALOVAL;
632 if (gotgctl & GOTGCTL_BSESVLD)
633 gotgctl |= GOTGCTL_BVALOVAL;
634 dwc2_writel(dwc2, gotgctl, GOTGCTL);
635 spin_unlock_irqrestore(&dwc2->lock, flags);
637 ggpio = dwc2_readl(dwc2, GGPIO);
638 ggpio &= ~GGPIO_STM32_OTG_GCCFG_IDEN;
639 ggpio &= ~GGPIO_STM32_OTG_GCCFG_VBDEN;
640 dwc2_writel(dwc2, ggpio, GGPIO);
642 regulator_disable(dwc2->usb33d);
645 if (dwc2->ll_hw_enabled &&
646 (is_device_mode || dwc2_host_can_poweroff_phy(dwc2))) {
647 ret = __dwc2_lowlevel_hw_disable(dwc2);
648 dwc2->phy_off_for_suspend = true;
654 static int __maybe_unused dwc2_resume(struct device *dev)
656 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
659 if (dwc2->phy_off_for_suspend && dwc2->ll_hw_enabled) {
660 ret = __dwc2_lowlevel_hw_enable(dwc2);
664 dwc2->phy_off_for_suspend = false;
666 if (dwc2->params.activate_stm_id_vb_detection) {
670 ret = regulator_enable(dwc2->usb33d);
674 ggpio = dwc2_readl(dwc2, GGPIO);
675 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
676 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
677 dwc2_writel(dwc2, ggpio, GGPIO);
679 /* ID/VBUS detection startup time */
680 usleep_range(5000, 7000);
682 spin_lock_irqsave(&dwc2->lock, flags);
683 gotgctl = dwc2_readl(dwc2, GOTGCTL);
684 gotgctl &= ~GOTGCTL_DBNCE_FLTR_BYPASS;
685 gotgctl &= ~(GOTGCTL_BVALOEN | GOTGCTL_AVALOEN |
686 GOTGCTL_BVALOVAL | GOTGCTL_AVALOVAL);
687 dwc2_writel(dwc2, gotgctl, GOTGCTL);
688 spin_unlock_irqrestore(&dwc2->lock, flags);
691 if (!dwc2->role_sw) {
692 /* Need to restore FORCEDEVMODE/FORCEHOSTMODE */
693 dwc2_force_dr_mode(dwc2);
695 dwc2_drd_resume(dwc2);
698 if (dwc2_is_device_mode(dwc2))
699 ret = dwc2_hsotg_resume(dwc2);
704 static const struct dev_pm_ops dwc2_dev_pm_ops = {
705 SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
708 static struct platform_driver dwc2_platform_driver = {
710 .name = dwc2_driver_name,
711 .of_match_table = dwc2_of_match_table,
712 .acpi_match_table = ACPI_PTR(dwc2_acpi_match),
713 .pm = &dwc2_dev_pm_ops,
715 .probe = dwc2_driver_probe,
716 .remove = dwc2_driver_remove,
717 .shutdown = dwc2_driver_shutdown,
720 module_platform_driver(dwc2_platform_driver);