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>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The names of the above-listed copyright holders may not be used
17 * to endorse or promote products derived from this software without
18 * specific prior written permission.
20 * ALTERNATIVELY, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") as published by the Free Software
22 * Foundation; either version 2 of the License, or (at your option) any
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/slab.h>
41 #include <linux/clk.h>
42 #include <linux/device.h>
43 #include <linux/dma-mapping.h>
44 #include <linux/of_device.h>
45 #include <linux/mutex.h>
46 #include <linux/platform_device.h>
47 #include <linux/phy/phy.h>
48 #include <linux/platform_data/s3c-hsotg.h>
49 #include <linux/reset.h>
51 #include <linux/usb/of.h>
57 static const char dwc2_driver_name[] = "dwc2";
60 * Check the dr_mode against the module configuration and hardware
63 * The hardware, module, and dr_mode, can each be set to host, device,
64 * or otg. Check that all these values are compatible and adjust the
65 * value of dr_mode if possible.
68 * HW MOD dr_mode dr_mode
69 * ------------------------------
80 * OTG OTG any : dr_mode
82 static int dwc2_get_dr_mode(struct dwc2_hsotg *hsotg)
84 enum usb_dr_mode mode;
86 hsotg->dr_mode = usb_get_dr_mode(hsotg->dev);
87 if (hsotg->dr_mode == USB_DR_MODE_UNKNOWN)
88 hsotg->dr_mode = USB_DR_MODE_OTG;
90 mode = hsotg->dr_mode;
92 if (dwc2_hw_is_device(hsotg)) {
93 if (IS_ENABLED(CONFIG_USB_DWC2_HOST)) {
95 "Controller does not support host mode.\n");
98 mode = USB_DR_MODE_PERIPHERAL;
99 } else if (dwc2_hw_is_host(hsotg)) {
100 if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL)) {
102 "Controller does not support device mode.\n");
105 mode = USB_DR_MODE_HOST;
107 if (IS_ENABLED(CONFIG_USB_DWC2_HOST))
108 mode = USB_DR_MODE_HOST;
109 else if (IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL))
110 mode = USB_DR_MODE_PERIPHERAL;
113 if (mode != hsotg->dr_mode) {
115 "Configuration mismatch. dr_mode forced to %s\n",
116 mode == USB_DR_MODE_HOST ? "host" : "device");
118 hsotg->dr_mode = mode;
124 static void __dwc2_disable_regulators(void *data)
126 struct dwc2_hsotg *hsotg = data;
128 regulator_bulk_disable(ARRAY_SIZE(hsotg->supplies), hsotg->supplies);
131 static int __dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
133 struct platform_device *pdev = to_platform_device(hsotg->dev);
136 ret = regulator_bulk_enable(ARRAY_SIZE(hsotg->supplies),
141 ret = devm_add_action_or_reset(&pdev->dev,
142 __dwc2_disable_regulators, hsotg);
147 ret = clk_prepare_enable(hsotg->clk);
153 ret = usb_phy_init(hsotg->uphy);
154 } else if (hsotg->plat && hsotg->plat->phy_init) {
155 ret = hsotg->plat->phy_init(pdev, hsotg->plat->phy_type);
157 ret = phy_power_on(hsotg->phy);
159 ret = phy_init(hsotg->phy);
166 * dwc2_lowlevel_hw_enable - enable platform lowlevel hw resources
167 * @hsotg: The driver state
169 * A wrapper for platform code responsible for controlling
170 * low-level USB platform resources (phy, clock, regulators)
172 int dwc2_lowlevel_hw_enable(struct dwc2_hsotg *hsotg)
174 int ret = __dwc2_lowlevel_hw_enable(hsotg);
177 hsotg->ll_hw_enabled = true;
181 static int __dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
183 struct platform_device *pdev = to_platform_device(hsotg->dev);
187 usb_phy_shutdown(hsotg->uphy);
188 } else if (hsotg->plat && hsotg->plat->phy_exit) {
189 ret = hsotg->plat->phy_exit(pdev, hsotg->plat->phy_type);
191 ret = phy_exit(hsotg->phy);
193 ret = phy_power_off(hsotg->phy);
199 clk_disable_unprepare(hsotg->clk);
205 * dwc2_lowlevel_hw_disable - disable platform lowlevel hw resources
206 * @hsotg: The driver state
208 * A wrapper for platform code responsible for controlling
209 * low-level USB platform resources (phy, clock, regulators)
211 int dwc2_lowlevel_hw_disable(struct dwc2_hsotg *hsotg)
213 int ret = __dwc2_lowlevel_hw_disable(hsotg);
216 hsotg->ll_hw_enabled = false;
220 static int dwc2_lowlevel_hw_init(struct dwc2_hsotg *hsotg)
224 hsotg->reset = devm_reset_control_get_optional(hsotg->dev, "dwc2");
225 if (IS_ERR(hsotg->reset)) {
226 ret = PTR_ERR(hsotg->reset);
227 dev_err(hsotg->dev, "error getting reset control %d\n", ret);
231 reset_control_deassert(hsotg->reset);
233 hsotg->reset_ecc = devm_reset_control_get_optional(hsotg->dev, "dwc2-ecc");
234 if (IS_ERR(hsotg->reset_ecc)) {
235 ret = PTR_ERR(hsotg->reset_ecc);
236 dev_err(hsotg->dev, "error getting reset control for ecc %d\n", ret);
240 reset_control_deassert(hsotg->reset_ecc);
243 * Attempt to find a generic PHY, then look for an old style
244 * USB PHY and then fall back to pdata
246 hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
247 if (IS_ERR(hsotg->phy)) {
248 ret = PTR_ERR(hsotg->phy);
257 dev_err(hsotg->dev, "error getting phy %d\n", ret);
263 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
264 if (IS_ERR(hsotg->uphy)) {
265 ret = PTR_ERR(hsotg->uphy);
274 dev_err(hsotg->dev, "error getting usb phy %d\n",
281 hsotg->plat = dev_get_platdata(hsotg->dev);
284 hsotg->clk = devm_clk_get_optional(hsotg->dev, "otg");
285 if (IS_ERR(hsotg->clk)) {
286 dev_err(hsotg->dev, "cannot get otg clock\n");
287 return PTR_ERR(hsotg->clk);
291 for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
292 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
294 ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
297 if (ret != -EPROBE_DEFER)
298 dev_err(hsotg->dev, "failed to request supplies: %d\n",
306 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
309 * @dev: Platform device
311 * This routine is called, for example, when the rmmod command is executed. The
312 * device may or may not be electrically present. If it is present, the driver
313 * stops device processing. Any resources used on behalf of this device are
316 static int dwc2_driver_remove(struct platform_device *dev)
318 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
320 dwc2_debugfs_exit(hsotg);
321 if (hsotg->hcd_enabled)
322 dwc2_hcd_remove(hsotg);
323 if (hsotg->gadget_enabled)
324 dwc2_hsotg_remove(hsotg);
326 dwc2_drd_exit(hsotg);
328 if (hsotg->params.activate_stm_id_vb_detection)
329 regulator_disable(hsotg->usb33d);
331 if (hsotg->ll_hw_enabled)
332 dwc2_lowlevel_hw_disable(hsotg);
334 reset_control_assert(hsotg->reset);
335 reset_control_assert(hsotg->reset_ecc);
341 * dwc2_driver_shutdown() - Called on device shutdown
343 * @dev: Platform device
345 * In specific conditions (involving usb hubs) dwc2 devices can create a
346 * lot of interrupts, even to the point of overwhelming devices running
347 * at low frequencies. Some devices need to do special clock handling
348 * at shutdown-time which may bring the system clock below the threshold
349 * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
350 * prevents reboots/poweroffs from getting stuck in such cases.
352 static void dwc2_driver_shutdown(struct platform_device *dev)
354 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
356 dwc2_disable_global_interrupts(hsotg);
357 synchronize_irq(hsotg->irq);
361 * dwc2_check_core_endianness() - Returns true if core and AHB have
362 * opposite endianness.
363 * @hsotg: Programming view of the DWC_otg controller.
365 static bool dwc2_check_core_endianness(struct dwc2_hsotg *hsotg)
369 snpsid = ioread32(hsotg->regs + GSNPSID);
370 if ((snpsid & GSNPSID_ID_MASK) == DWC2_OTG_ID ||
371 (snpsid & GSNPSID_ID_MASK) == DWC2_FS_IOT_ID ||
372 (snpsid & GSNPSID_ID_MASK) == DWC2_HS_IOT_ID)
380 * @hsotg: Programming view of the DWC_otg controller
383 int dwc2_check_core_version(struct dwc2_hsotg *hsotg)
385 struct dwc2_hw_params *hw = &hsotg->hw_params;
388 * Attempt to ensure this device is really a DWC_otg Controller.
389 * Read and verify the GSNPSID register contents. The value should be
390 * 0x45f4xxxx, 0x5531xxxx or 0x5532xxxx
393 hw->snpsid = dwc2_readl(hsotg, GSNPSID);
394 if ((hw->snpsid & GSNPSID_ID_MASK) != DWC2_OTG_ID &&
395 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_FS_IOT_ID &&
396 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_HS_IOT_ID) {
397 dev_err(hsotg->dev, "Bad value for GSNPSID: 0x%08x\n",
402 dev_dbg(hsotg->dev, "Core Release: %1x.%1x%1x%1x (snpsid=%x)\n",
403 hw->snpsid >> 12 & 0xf, hw->snpsid >> 8 & 0xf,
404 hw->snpsid >> 4 & 0xf, hw->snpsid & 0xf, hw->snpsid);
409 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
412 * @dev: Platform device
414 * This routine creates the driver components required to control the device
415 * (core, HCD, and PCD) and initializes the device. The driver components are
416 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
417 * in the device private data. This allows the driver to access the dwc2_hsotg
418 * structure on subsequent calls to driver methods for this device.
420 static int dwc2_driver_probe(struct platform_device *dev)
422 struct dwc2_hsotg *hsotg;
423 struct resource *res;
426 hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
430 hsotg->dev = &dev->dev;
433 * Use reasonable defaults so platforms don't have to provide these.
435 if (!dev->dev.dma_mask)
436 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
437 retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
439 dev_err(&dev->dev, "can't set coherent DMA mask: %d\n", retval);
443 hsotg->regs = devm_platform_get_and_ioremap_resource(dev, 0, &res);
444 if (IS_ERR(hsotg->regs))
445 return PTR_ERR(hsotg->regs);
447 dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
448 (unsigned long)res->start, hsotg->regs);
450 retval = dwc2_lowlevel_hw_init(hsotg);
454 spin_lock_init(&hsotg->lock);
456 hsotg->irq = platform_get_irq(dev, 0);
460 dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
462 retval = devm_request_irq(hsotg->dev, hsotg->irq,
463 dwc2_handle_common_intr, IRQF_SHARED,
464 dev_name(hsotg->dev), hsotg);
468 hsotg->vbus_supply = devm_regulator_get_optional(hsotg->dev, "vbus");
469 if (IS_ERR(hsotg->vbus_supply)) {
470 retval = PTR_ERR(hsotg->vbus_supply);
471 hsotg->vbus_supply = NULL;
472 if (retval != -ENODEV)
476 retval = dwc2_lowlevel_hw_enable(hsotg);
480 hsotg->needs_byte_swap = dwc2_check_core_endianness(hsotg);
482 retval = dwc2_get_dr_mode(hsotg);
486 hsotg->need_phy_for_wake =
487 of_property_read_bool(dev->dev.of_node,
488 "snps,need-phy-for-wake");
491 * Before performing any core related operations
492 * check core version.
494 retval = dwc2_check_core_version(hsotg);
499 * Reset before dwc2_get_hwparams() then it could get power-on real
500 * reset value form registers.
502 retval = dwc2_core_reset(hsotg, false);
506 /* Detect config values from hardware */
507 retval = dwc2_get_hwparams(hsotg);
512 * For OTG cores, set the force mode bits to reflect the value
513 * of dr_mode. Force mode bits should not be touched at any
514 * other time after this.
516 dwc2_force_dr_mode(hsotg);
518 retval = dwc2_init_params(hsotg);
522 if (hsotg->params.activate_stm_id_vb_detection) {
525 hsotg->usb33d = devm_regulator_get(hsotg->dev, "usb33d");
526 if (IS_ERR(hsotg->usb33d)) {
527 retval = PTR_ERR(hsotg->usb33d);
528 if (retval != -EPROBE_DEFER)
530 "failed to request usb33d supply: %d\n",
534 retval = regulator_enable(hsotg->usb33d);
537 "failed to enable usb33d supply: %d\n", retval);
541 ggpio = dwc2_readl(hsotg, GGPIO);
542 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
543 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
544 dwc2_writel(hsotg, ggpio, GGPIO);
547 retval = dwc2_drd_init(hsotg);
549 if (retval != -EPROBE_DEFER)
550 dev_err(hsotg->dev, "failed to initialize dual-role\n");
554 if (hsotg->dr_mode != USB_DR_MODE_HOST) {
555 retval = dwc2_gadget_init(hsotg);
558 hsotg->gadget_enabled = 1;
562 * If we need PHY for wakeup we must be wakeup capable.
563 * When we have a device that can wake without the PHY we
564 * can adjust this condition.
566 if (hsotg->need_phy_for_wake)
567 device_set_wakeup_capable(&dev->dev, true);
569 hsotg->reset_phy_on_wake =
570 of_property_read_bool(dev->dev.of_node,
571 "snps,reset-phy-on-wake");
572 if (hsotg->reset_phy_on_wake && !hsotg->phy) {
574 "Quirk reset-phy-on-wake only supports generic PHYs\n");
575 hsotg->reset_phy_on_wake = false;
578 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
579 retval = dwc2_hcd_init(hsotg);
581 if (hsotg->gadget_enabled)
582 dwc2_hsotg_remove(hsotg);
585 hsotg->hcd_enabled = 1;
588 platform_set_drvdata(dev, hsotg);
589 hsotg->hibernated = 0;
591 dwc2_debugfs_init(hsotg);
593 /* Gadget code manages lowlevel hw on its own */
594 if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL)
595 dwc2_lowlevel_hw_disable(hsotg);
597 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
598 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
599 /* Postponed adding a new gadget to the udc class driver list */
600 if (hsotg->gadget_enabled) {
601 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
603 hsotg->gadget.udc = NULL;
604 dwc2_hsotg_remove(hsotg);
608 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
611 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
612 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
614 dwc2_debugfs_exit(hsotg);
615 if (hsotg->hcd_enabled)
616 dwc2_hcd_remove(hsotg);
619 dwc2_drd_exit(hsotg);
622 if (hsotg->params.activate_stm_id_vb_detection)
623 regulator_disable(hsotg->usb33d);
625 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL)
626 dwc2_lowlevel_hw_disable(hsotg);
630 static int __maybe_unused dwc2_suspend(struct device *dev)
632 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
633 bool is_device_mode = dwc2_is_device_mode(dwc2);
637 dwc2_hsotg_suspend(dwc2);
639 dwc2_drd_suspend(dwc2);
641 if (dwc2->params.activate_stm_id_vb_detection) {
646 * Need to force the mode to the current mode to avoid Mode
647 * Mismatch Interrupt when ID detection will be disabled.
649 dwc2_force_mode(dwc2, !is_device_mode);
651 spin_lock_irqsave(&dwc2->lock, flags);
652 gotgctl = dwc2_readl(dwc2, GOTGCTL);
653 /* bypass debounce filter, enable overrides */
654 gotgctl |= GOTGCTL_DBNCE_FLTR_BYPASS;
655 gotgctl |= GOTGCTL_BVALOEN | GOTGCTL_AVALOEN;
656 /* Force A / B session if needed */
657 if (gotgctl & GOTGCTL_ASESVLD)
658 gotgctl |= GOTGCTL_AVALOVAL;
659 if (gotgctl & GOTGCTL_BSESVLD)
660 gotgctl |= GOTGCTL_BVALOVAL;
661 dwc2_writel(dwc2, gotgctl, GOTGCTL);
662 spin_unlock_irqrestore(&dwc2->lock, flags);
664 ggpio = dwc2_readl(dwc2, GGPIO);
665 ggpio &= ~GGPIO_STM32_OTG_GCCFG_IDEN;
666 ggpio &= ~GGPIO_STM32_OTG_GCCFG_VBDEN;
667 dwc2_writel(dwc2, ggpio, GGPIO);
669 regulator_disable(dwc2->usb33d);
672 if (dwc2->ll_hw_enabled &&
673 (is_device_mode || dwc2_host_can_poweroff_phy(dwc2))) {
674 ret = __dwc2_lowlevel_hw_disable(dwc2);
675 dwc2->phy_off_for_suspend = true;
681 static int __maybe_unused dwc2_resume(struct device *dev)
683 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
686 if (dwc2->phy_off_for_suspend && dwc2->ll_hw_enabled) {
687 ret = __dwc2_lowlevel_hw_enable(dwc2);
691 dwc2->phy_off_for_suspend = false;
693 if (dwc2->params.activate_stm_id_vb_detection) {
697 ret = regulator_enable(dwc2->usb33d);
701 ggpio = dwc2_readl(dwc2, GGPIO);
702 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
703 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
704 dwc2_writel(dwc2, ggpio, GGPIO);
706 /* ID/VBUS detection startup time */
707 usleep_range(5000, 7000);
709 spin_lock_irqsave(&dwc2->lock, flags);
710 gotgctl = dwc2_readl(dwc2, GOTGCTL);
711 gotgctl &= ~GOTGCTL_DBNCE_FLTR_BYPASS;
712 gotgctl &= ~(GOTGCTL_BVALOEN | GOTGCTL_AVALOEN |
713 GOTGCTL_BVALOVAL | GOTGCTL_AVALOVAL);
714 dwc2_writel(dwc2, gotgctl, GOTGCTL);
715 spin_unlock_irqrestore(&dwc2->lock, flags);
718 /* Need to restore FORCEDEVMODE/FORCEHOSTMODE */
719 dwc2_force_dr_mode(dwc2);
721 dwc2_drd_resume(dwc2);
723 if (dwc2_is_device_mode(dwc2))
724 ret = dwc2_hsotg_resume(dwc2);
729 static const struct dev_pm_ops dwc2_dev_pm_ops = {
730 SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
733 static struct platform_driver dwc2_platform_driver = {
735 .name = dwc2_driver_name,
736 .of_match_table = dwc2_of_match_table,
737 .pm = &dwc2_dev_pm_ops,
739 .probe = dwc2_driver_probe,
740 .remove = dwc2_driver_remove,
741 .shutdown = dwc2_driver_shutdown,
744 module_platform_driver(dwc2_platform_driver);
746 MODULE_DESCRIPTION("DESIGNWARE HS OTG Platform Glue");
747 MODULE_AUTHOR("Matthijs Kooijman <matthijs@stdin.nl>");
748 MODULE_LICENSE("Dual BSD/GPL");