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 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset),
227 "error getting reset control\n");
229 reset_control_deassert(hsotg->reset);
231 hsotg->reset_ecc = devm_reset_control_get_optional(hsotg->dev, "dwc2-ecc");
232 if (IS_ERR(hsotg->reset_ecc))
233 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->reset_ecc),
234 "error getting reset control for ecc\n");
236 reset_control_deassert(hsotg->reset_ecc);
239 * Attempt to find a generic PHY, then look for an old style
240 * USB PHY and then fall back to pdata
242 hsotg->phy = devm_phy_get(hsotg->dev, "usb2-phy");
243 if (IS_ERR(hsotg->phy)) {
244 ret = PTR_ERR(hsotg->phy);
251 return dev_err_probe(hsotg->dev, ret, "error getting phy\n");
256 hsotg->uphy = devm_usb_get_phy(hsotg->dev, USB_PHY_TYPE_USB2);
257 if (IS_ERR(hsotg->uphy)) {
258 ret = PTR_ERR(hsotg->uphy);
265 return dev_err_probe(hsotg->dev, ret, "error getting usb phy\n");
270 hsotg->plat = dev_get_platdata(hsotg->dev);
273 hsotg->clk = devm_clk_get_optional(hsotg->dev, "otg");
274 if (IS_ERR(hsotg->clk))
275 return dev_err_probe(hsotg->dev, PTR_ERR(hsotg->clk), "cannot get otg clock\n");
278 for (i = 0; i < ARRAY_SIZE(hsotg->supplies); i++)
279 hsotg->supplies[i].supply = dwc2_hsotg_supply_names[i];
281 ret = devm_regulator_bulk_get(hsotg->dev, ARRAY_SIZE(hsotg->supplies),
284 return dev_err_probe(hsotg->dev, ret, "failed to request supplies\n");
290 * dwc2_driver_remove() - Called when the DWC_otg core is unregistered with the
293 * @dev: Platform device
295 * This routine is called, for example, when the rmmod command is executed. The
296 * device may or may not be electrically present. If it is present, the driver
297 * stops device processing. Any resources used on behalf of this device are
300 static int dwc2_driver_remove(struct platform_device *dev)
302 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
303 struct dwc2_gregs_backup *gr;
306 gr = &hsotg->gr_backup;
308 /* Exit Hibernation when driver is removed. */
309 if (hsotg->hibernated) {
310 if (gr->gotgctl & GOTGCTL_CURMODE_HOST)
311 ret = dwc2_exit_hibernation(hsotg, 0, 0, 1);
313 ret = dwc2_exit_hibernation(hsotg, 0, 0, 0);
317 "exit hibernation failed.\n");
320 /* Exit Partial Power Down when driver is removed. */
322 ret = dwc2_exit_partial_power_down(hsotg, 0, true);
325 "exit partial_power_down failed\n");
328 /* Exit clock gating when driver is removed. */
329 if (hsotg->params.power_down == DWC2_POWER_DOWN_PARAM_NONE &&
330 hsotg->bus_suspended) {
331 if (dwc2_is_device_mode(hsotg))
332 dwc2_gadget_exit_clock_gating(hsotg, 0);
334 dwc2_host_exit_clock_gating(hsotg, 0);
337 dwc2_debugfs_exit(hsotg);
338 if (hsotg->hcd_enabled)
339 dwc2_hcd_remove(hsotg);
340 if (hsotg->gadget_enabled)
341 dwc2_hsotg_remove(hsotg);
343 dwc2_drd_exit(hsotg);
345 if (hsotg->params.activate_stm_id_vb_detection)
346 regulator_disable(hsotg->usb33d);
348 if (hsotg->ll_hw_enabled)
349 dwc2_lowlevel_hw_disable(hsotg);
351 reset_control_assert(hsotg->reset);
352 reset_control_assert(hsotg->reset_ecc);
358 * dwc2_driver_shutdown() - Called on device shutdown
360 * @dev: Platform device
362 * In specific conditions (involving usb hubs) dwc2 devices can create a
363 * lot of interrupts, even to the point of overwhelming devices running
364 * at low frequencies. Some devices need to do special clock handling
365 * at shutdown-time which may bring the system clock below the threshold
366 * of being able to handle the dwc2 interrupts. Disabling dwc2-irqs
367 * prevents reboots/poweroffs from getting stuck in such cases.
369 static void dwc2_driver_shutdown(struct platform_device *dev)
371 struct dwc2_hsotg *hsotg = platform_get_drvdata(dev);
373 dwc2_disable_global_interrupts(hsotg);
374 synchronize_irq(hsotg->irq);
378 * dwc2_check_core_endianness() - Returns true if core and AHB have
379 * opposite endianness.
380 * @hsotg: Programming view of the DWC_otg controller.
382 static bool dwc2_check_core_endianness(struct dwc2_hsotg *hsotg)
386 snpsid = ioread32(hsotg->regs + GSNPSID);
387 if ((snpsid & GSNPSID_ID_MASK) == DWC2_OTG_ID ||
388 (snpsid & GSNPSID_ID_MASK) == DWC2_FS_IOT_ID ||
389 (snpsid & GSNPSID_ID_MASK) == DWC2_HS_IOT_ID)
395 * dwc2_check_core_version() - Check core version
397 * @hsotg: Programming view of the DWC_otg controller
400 int dwc2_check_core_version(struct dwc2_hsotg *hsotg)
402 struct dwc2_hw_params *hw = &hsotg->hw_params;
405 * Attempt to ensure this device is really a DWC_otg Controller.
406 * Read and verify the GSNPSID register contents. The value should be
407 * 0x45f4xxxx, 0x5531xxxx or 0x5532xxxx
410 hw->snpsid = dwc2_readl(hsotg, GSNPSID);
411 if ((hw->snpsid & GSNPSID_ID_MASK) != DWC2_OTG_ID &&
412 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_FS_IOT_ID &&
413 (hw->snpsid & GSNPSID_ID_MASK) != DWC2_HS_IOT_ID) {
414 dev_err(hsotg->dev, "Bad value for GSNPSID: 0x%08x\n",
419 dev_dbg(hsotg->dev, "Core Release: %1x.%1x%1x%1x (snpsid=%x)\n",
420 hw->snpsid >> 12 & 0xf, hw->snpsid >> 8 & 0xf,
421 hw->snpsid >> 4 & 0xf, hw->snpsid & 0xf, hw->snpsid);
426 * dwc2_driver_probe() - Called when the DWC_otg core is bound to the DWC_otg
429 * @dev: Platform device
431 * This routine creates the driver components required to control the device
432 * (core, HCD, and PCD) and initializes the device. The driver components are
433 * stored in a dwc2_hsotg structure. A reference to the dwc2_hsotg is saved
434 * in the device private data. This allows the driver to access the dwc2_hsotg
435 * structure on subsequent calls to driver methods for this device.
437 static int dwc2_driver_probe(struct platform_device *dev)
439 struct dwc2_hsotg *hsotg;
440 struct resource *res;
443 hsotg = devm_kzalloc(&dev->dev, sizeof(*hsotg), GFP_KERNEL);
447 hsotg->dev = &dev->dev;
450 * Use reasonable defaults so platforms don't have to provide these.
452 if (!dev->dev.dma_mask)
453 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
454 retval = dma_set_coherent_mask(&dev->dev, DMA_BIT_MASK(32));
456 dev_err(&dev->dev, "can't set coherent DMA mask: %d\n", retval);
460 hsotg->regs = devm_platform_get_and_ioremap_resource(dev, 0, &res);
461 if (IS_ERR(hsotg->regs))
462 return PTR_ERR(hsotg->regs);
464 dev_dbg(&dev->dev, "mapped PA %08lx to VA %p\n",
465 (unsigned long)res->start, hsotg->regs);
467 retval = dwc2_lowlevel_hw_init(hsotg);
471 spin_lock_init(&hsotg->lock);
473 hsotg->irq = platform_get_irq(dev, 0);
477 dev_dbg(hsotg->dev, "registering common handler for irq%d\n",
479 retval = devm_request_irq(hsotg->dev, hsotg->irq,
480 dwc2_handle_common_intr, IRQF_SHARED,
481 dev_name(hsotg->dev), hsotg);
485 hsotg->vbus_supply = devm_regulator_get_optional(hsotg->dev, "vbus");
486 if (IS_ERR(hsotg->vbus_supply)) {
487 retval = PTR_ERR(hsotg->vbus_supply);
488 hsotg->vbus_supply = NULL;
489 if (retval != -ENODEV)
493 retval = dwc2_lowlevel_hw_enable(hsotg);
497 hsotg->needs_byte_swap = dwc2_check_core_endianness(hsotg);
499 retval = dwc2_get_dr_mode(hsotg);
503 hsotg->need_phy_for_wake =
504 of_property_read_bool(dev->dev.of_node,
505 "snps,need-phy-for-wake");
508 * Before performing any core related operations
509 * check core version.
511 retval = dwc2_check_core_version(hsotg);
516 * Reset before dwc2_get_hwparams() then it could get power-on real
517 * reset value form registers.
519 retval = dwc2_core_reset(hsotg, false);
523 /* Detect config values from hardware */
524 retval = dwc2_get_hwparams(hsotg);
529 * For OTG cores, set the force mode bits to reflect the value
530 * of dr_mode. Force mode bits should not be touched at any
531 * other time after this.
533 dwc2_force_dr_mode(hsotg);
535 retval = dwc2_init_params(hsotg);
539 if (hsotg->params.activate_stm_id_vb_detection) {
542 hsotg->usb33d = devm_regulator_get(hsotg->dev, "usb33d");
543 if (IS_ERR(hsotg->usb33d)) {
544 retval = PTR_ERR(hsotg->usb33d);
545 dev_err_probe(hsotg->dev, retval, "failed to request usb33d supply\n");
548 retval = regulator_enable(hsotg->usb33d);
550 dev_err_probe(hsotg->dev, retval, "failed to enable usb33d supply\n");
554 ggpio = dwc2_readl(hsotg, GGPIO);
555 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
556 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
557 dwc2_writel(hsotg, ggpio, GGPIO);
559 /* ID/VBUS detection startup time */
560 usleep_range(5000, 7000);
563 retval = dwc2_drd_init(hsotg);
565 dev_err_probe(hsotg->dev, retval, "failed to initialize dual-role\n");
569 if (hsotg->dr_mode != USB_DR_MODE_HOST) {
570 retval = dwc2_gadget_init(hsotg);
573 hsotg->gadget_enabled = 1;
577 * If we need PHY for wakeup we must be wakeup capable.
578 * When we have a device that can wake without the PHY we
579 * can adjust this condition.
581 if (hsotg->need_phy_for_wake)
582 device_set_wakeup_capable(&dev->dev, true);
584 hsotg->reset_phy_on_wake =
585 of_property_read_bool(dev->dev.of_node,
586 "snps,reset-phy-on-wake");
587 if (hsotg->reset_phy_on_wake && !hsotg->phy) {
589 "Quirk reset-phy-on-wake only supports generic PHYs\n");
590 hsotg->reset_phy_on_wake = false;
593 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL) {
594 retval = dwc2_hcd_init(hsotg);
596 if (hsotg->gadget_enabled)
597 dwc2_hsotg_remove(hsotg);
600 hsotg->hcd_enabled = 1;
603 platform_set_drvdata(dev, hsotg);
604 hsotg->hibernated = 0;
606 dwc2_debugfs_init(hsotg);
608 /* Gadget code manages lowlevel hw on its own */
609 if (hsotg->dr_mode == USB_DR_MODE_PERIPHERAL)
610 dwc2_lowlevel_hw_disable(hsotg);
612 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
613 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
614 /* Postponed adding a new gadget to the udc class driver list */
615 if (hsotg->gadget_enabled) {
616 retval = usb_add_gadget_udc(hsotg->dev, &hsotg->gadget);
618 hsotg->gadget.udc = NULL;
619 dwc2_hsotg_remove(hsotg);
623 #endif /* CONFIG_USB_DWC2_PERIPHERAL || CONFIG_USB_DWC2_DUAL_ROLE */
626 #if IS_ENABLED(CONFIG_USB_DWC2_PERIPHERAL) || \
627 IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)
629 dwc2_debugfs_exit(hsotg);
630 if (hsotg->hcd_enabled)
631 dwc2_hcd_remove(hsotg);
634 dwc2_drd_exit(hsotg);
637 if (hsotg->params.activate_stm_id_vb_detection)
638 regulator_disable(hsotg->usb33d);
640 if (hsotg->dr_mode != USB_DR_MODE_PERIPHERAL)
641 dwc2_lowlevel_hw_disable(hsotg);
645 static int __maybe_unused dwc2_suspend(struct device *dev)
647 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
648 bool is_device_mode = dwc2_is_device_mode(dwc2);
652 dwc2_hsotg_suspend(dwc2);
654 dwc2_drd_suspend(dwc2);
656 if (dwc2->params.activate_stm_id_vb_detection) {
661 * Need to force the mode to the current mode to avoid Mode
662 * Mismatch Interrupt when ID detection will be disabled.
664 dwc2_force_mode(dwc2, !is_device_mode);
666 spin_lock_irqsave(&dwc2->lock, flags);
667 gotgctl = dwc2_readl(dwc2, GOTGCTL);
668 /* bypass debounce filter, enable overrides */
669 gotgctl |= GOTGCTL_DBNCE_FLTR_BYPASS;
670 gotgctl |= GOTGCTL_BVALOEN | GOTGCTL_AVALOEN;
671 /* Force A / B session if needed */
672 if (gotgctl & GOTGCTL_ASESVLD)
673 gotgctl |= GOTGCTL_AVALOVAL;
674 if (gotgctl & GOTGCTL_BSESVLD)
675 gotgctl |= GOTGCTL_BVALOVAL;
676 dwc2_writel(dwc2, gotgctl, GOTGCTL);
677 spin_unlock_irqrestore(&dwc2->lock, flags);
679 ggpio = dwc2_readl(dwc2, GGPIO);
680 ggpio &= ~GGPIO_STM32_OTG_GCCFG_IDEN;
681 ggpio &= ~GGPIO_STM32_OTG_GCCFG_VBDEN;
682 dwc2_writel(dwc2, ggpio, GGPIO);
684 regulator_disable(dwc2->usb33d);
687 if (dwc2->ll_hw_enabled &&
688 (is_device_mode || dwc2_host_can_poweroff_phy(dwc2))) {
689 ret = __dwc2_lowlevel_hw_disable(dwc2);
690 dwc2->phy_off_for_suspend = true;
696 static int __maybe_unused dwc2_resume(struct device *dev)
698 struct dwc2_hsotg *dwc2 = dev_get_drvdata(dev);
701 if (dwc2->phy_off_for_suspend && dwc2->ll_hw_enabled) {
702 ret = __dwc2_lowlevel_hw_enable(dwc2);
706 dwc2->phy_off_for_suspend = false;
708 if (dwc2->params.activate_stm_id_vb_detection) {
712 ret = regulator_enable(dwc2->usb33d);
716 ggpio = dwc2_readl(dwc2, GGPIO);
717 ggpio |= GGPIO_STM32_OTG_GCCFG_IDEN;
718 ggpio |= GGPIO_STM32_OTG_GCCFG_VBDEN;
719 dwc2_writel(dwc2, ggpio, GGPIO);
721 /* ID/VBUS detection startup time */
722 usleep_range(5000, 7000);
724 spin_lock_irqsave(&dwc2->lock, flags);
725 gotgctl = dwc2_readl(dwc2, GOTGCTL);
726 gotgctl &= ~GOTGCTL_DBNCE_FLTR_BYPASS;
727 gotgctl &= ~(GOTGCTL_BVALOEN | GOTGCTL_AVALOEN |
728 GOTGCTL_BVALOVAL | GOTGCTL_AVALOVAL);
729 dwc2_writel(dwc2, gotgctl, GOTGCTL);
730 spin_unlock_irqrestore(&dwc2->lock, flags);
733 if (!dwc2->role_sw) {
734 /* Need to restore FORCEDEVMODE/FORCEHOSTMODE */
735 dwc2_force_dr_mode(dwc2);
737 dwc2_drd_resume(dwc2);
740 if (dwc2_is_device_mode(dwc2))
741 ret = dwc2_hsotg_resume(dwc2);
746 static const struct dev_pm_ops dwc2_dev_pm_ops = {
747 SET_SYSTEM_SLEEP_PM_OPS(dwc2_suspend, dwc2_resume)
750 static struct platform_driver dwc2_platform_driver = {
752 .name = dwc2_driver_name,
753 .of_match_table = dwc2_of_match_table,
754 .acpi_match_table = ACPI_PTR(dwc2_acpi_match),
755 .pm = &dwc2_dev_pm_ops,
757 .probe = dwc2_driver_probe,
758 .remove = dwc2_driver_remove,
759 .shutdown = dwc2_driver_shutdown,
762 module_platform_driver(dwc2_platform_driver);