| // SPDX-License-Identifier: GPL-2.0 |
| /* Copyright (c) 2018, The Linux Foundation. All rights reserved. |
| * |
| * Inspired by dwc3-of-simple.c |
| */ |
| |
| #include <linux/io.h> |
| #include <linux/of.h> |
| #include <linux/clk.h> |
| #include <linux/irq.h> |
| #include <linux/clk-provider.h> |
| #include <linux/module.h> |
| #include <linux/kernel.h> |
| #include <linux/extcon.h> |
| #include <linux/of_platform.h> |
| #include <linux/platform_device.h> |
| #include <linux/phy/phy.h> |
| #include <linux/usb/of.h> |
| #include <linux/reset.h> |
| #include <linux/iopoll.h> |
| |
| #include "core.h" |
| |
| /* USB QSCRATCH Hardware registers */ |
| #define QSCRATCH_HS_PHY_CTRL 0x10 |
| #define UTMI_OTG_VBUS_VALID BIT(20) |
| #define SW_SESSVLD_SEL BIT(28) |
| |
| #define QSCRATCH_SS_PHY_CTRL 0x30 |
| #define LANE0_PWR_PRESENT BIT(24) |
| |
| #define QSCRATCH_GENERAL_CFG 0x08 |
| #define PIPE_UTMI_CLK_SEL BIT(0) |
| #define PIPE3_PHYSTATUS_SW BIT(3) |
| #define PIPE_UTMI_CLK_DIS BIT(8) |
| |
| #define PWR_EVNT_IRQ_STAT_REG 0x58 |
| #define PWR_EVNT_LPM_IN_L2_MASK BIT(4) |
| #define PWR_EVNT_LPM_OUT_L2_MASK BIT(5) |
| |
| struct dwc3_qcom { |
| struct device *dev; |
| void __iomem *qscratch_base; |
| struct platform_device *dwc3; |
| struct clk **clks; |
| int num_clocks; |
| struct reset_control *resets; |
| |
| int hs_phy_irq; |
| int dp_hs_phy_irq; |
| int dm_hs_phy_irq; |
| int ss_phy_irq; |
| |
| struct extcon_dev *edev; |
| struct extcon_dev *host_edev; |
| struct notifier_block vbus_nb; |
| struct notifier_block host_nb; |
| |
| enum usb_dr_mode mode; |
| bool is_suspended; |
| bool pm_suspended; |
| }; |
| |
| static inline void dwc3_qcom_setbits(void __iomem *base, u32 offset, u32 val) |
| { |
| u32 reg; |
| |
| reg = readl(base + offset); |
| reg |= val; |
| writel(reg, base + offset); |
| |
| /* ensure that above write is through */ |
| readl(base + offset); |
| } |
| |
| static inline void dwc3_qcom_clrbits(void __iomem *base, u32 offset, u32 val) |
| { |
| u32 reg; |
| |
| reg = readl(base + offset); |
| reg &= ~val; |
| writel(reg, base + offset); |
| |
| /* ensure that above write is through */ |
| readl(base + offset); |
| } |
| |
| static void dwc3_qcom_vbus_override_enable(struct dwc3_qcom *qcom, bool enable) |
| { |
| if (enable) { |
| dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_SS_PHY_CTRL, |
| LANE0_PWR_PRESENT); |
| dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_HS_PHY_CTRL, |
| UTMI_OTG_VBUS_VALID | SW_SESSVLD_SEL); |
| } else { |
| dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_SS_PHY_CTRL, |
| LANE0_PWR_PRESENT); |
| dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_HS_PHY_CTRL, |
| UTMI_OTG_VBUS_VALID | SW_SESSVLD_SEL); |
| } |
| } |
| |
| static int dwc3_qcom_vbus_notifier(struct notifier_block *nb, |
| unsigned long event, void *ptr) |
| { |
| struct dwc3_qcom *qcom = container_of(nb, struct dwc3_qcom, vbus_nb); |
| |
| /* enable vbus override for device mode */ |
| dwc3_qcom_vbus_override_enable(qcom, event); |
| qcom->mode = event ? USB_DR_MODE_PERIPHERAL : USB_DR_MODE_HOST; |
| |
| return NOTIFY_DONE; |
| } |
| |
| static int dwc3_qcom_host_notifier(struct notifier_block *nb, |
| unsigned long event, void *ptr) |
| { |
| struct dwc3_qcom *qcom = container_of(nb, struct dwc3_qcom, host_nb); |
| |
| /* disable vbus override in host mode */ |
| dwc3_qcom_vbus_override_enable(qcom, !event); |
| qcom->mode = event ? USB_DR_MODE_HOST : USB_DR_MODE_PERIPHERAL; |
| |
| return NOTIFY_DONE; |
| } |
| |
| static int dwc3_qcom_register_extcon(struct dwc3_qcom *qcom) |
| { |
| struct device *dev = qcom->dev; |
| struct extcon_dev *host_edev; |
| int ret; |
| |
| if (!of_property_read_bool(dev->of_node, "extcon")) |
| return 0; |
| |
| qcom->edev = extcon_get_edev_by_phandle(dev, 0); |
| if (IS_ERR(qcom->edev)) |
| return PTR_ERR(qcom->edev); |
| |
| qcom->vbus_nb.notifier_call = dwc3_qcom_vbus_notifier; |
| |
| qcom->host_edev = extcon_get_edev_by_phandle(dev, 1); |
| if (IS_ERR(qcom->host_edev)) |
| qcom->host_edev = NULL; |
| |
| ret = devm_extcon_register_notifier(dev, qcom->edev, EXTCON_USB, |
| &qcom->vbus_nb); |
| if (ret < 0) { |
| dev_err(dev, "VBUS notifier register failed\n"); |
| return ret; |
| } |
| |
| if (qcom->host_edev) |
| host_edev = qcom->host_edev; |
| else |
| host_edev = qcom->edev; |
| |
| qcom->host_nb.notifier_call = dwc3_qcom_host_notifier; |
| ret = devm_extcon_register_notifier(dev, host_edev, EXTCON_USB_HOST, |
| &qcom->host_nb); |
| if (ret < 0) { |
| dev_err(dev, "Host notifier register failed\n"); |
| return ret; |
| } |
| |
| /* Update initial VBUS override based on extcon state */ |
| if (extcon_get_state(qcom->edev, EXTCON_USB) || |
| !extcon_get_state(host_edev, EXTCON_USB_HOST)) |
| dwc3_qcom_vbus_notifier(&qcom->vbus_nb, true, qcom->edev); |
| else |
| dwc3_qcom_vbus_notifier(&qcom->vbus_nb, false, qcom->edev); |
| |
| return 0; |
| } |
| |
| /* Only usable in contexts where the role can not change. */ |
| static bool dwc3_qcom_is_host(struct dwc3_qcom *qcom) |
| { |
| struct dwc3 *dwc; |
| |
| /* |
| * FIXME: Fix this layering violation. |
| */ |
| dwc = platform_get_drvdata(qcom->dwc3); |
| |
| /* Core driver may not have probed yet. */ |
| if (!dwc) |
| return false; |
| |
| return dwc->xhci; |
| } |
| |
| static void dwc3_qcom_enable_wakeup_irq(int irq) |
| { |
| if (!irq) |
| return; |
| |
| enable_irq(irq); |
| enable_irq_wake(irq); |
| } |
| |
| static void dwc3_qcom_disable_wakeup_irq(int irq) |
| { |
| if (!irq) |
| return; |
| |
| disable_irq_wake(irq); |
| disable_irq_nosync(irq); |
| } |
| |
| static void dwc3_qcom_disable_interrupts(struct dwc3_qcom *qcom) |
| { |
| dwc3_qcom_disable_wakeup_irq(qcom->hs_phy_irq); |
| |
| dwc3_qcom_disable_wakeup_irq(qcom->dp_hs_phy_irq); |
| |
| dwc3_qcom_disable_wakeup_irq(qcom->dm_hs_phy_irq); |
| |
| dwc3_qcom_disable_wakeup_irq(qcom->ss_phy_irq); |
| } |
| |
| static void dwc3_qcom_enable_interrupts(struct dwc3_qcom *qcom) |
| { |
| dwc3_qcom_enable_wakeup_irq(qcom->hs_phy_irq); |
| |
| dwc3_qcom_enable_wakeup_irq(qcom->dp_hs_phy_irq); |
| |
| dwc3_qcom_enable_wakeup_irq(qcom->dm_hs_phy_irq); |
| |
| dwc3_qcom_enable_wakeup_irq(qcom->ss_phy_irq); |
| } |
| |
| static int dwc3_qcom_suspend(struct dwc3_qcom *qcom) |
| { |
| u32 val; |
| int i; |
| |
| if (qcom->is_suspended) |
| return 0; |
| |
| val = readl(qcom->qscratch_base + PWR_EVNT_IRQ_STAT_REG); |
| if (!(val & PWR_EVNT_LPM_IN_L2_MASK)) |
| dev_err(qcom->dev, "HS-PHY not in L2\n"); |
| |
| for (i = qcom->num_clocks - 1; i >= 0; i--) |
| clk_disable_unprepare(qcom->clks[i]); |
| |
| if (device_may_wakeup(qcom->dev)) |
| dwc3_qcom_enable_interrupts(qcom); |
| |
| qcom->is_suspended = true; |
| |
| return 0; |
| } |
| |
| static int dwc3_qcom_resume(struct dwc3_qcom *qcom) |
| { |
| int ret; |
| int i; |
| |
| if (!qcom->is_suspended) |
| return 0; |
| |
| if (device_may_wakeup(qcom->dev)) |
| dwc3_qcom_disable_interrupts(qcom); |
| |
| for (i = 0; i < qcom->num_clocks; i++) { |
| ret = clk_prepare_enable(qcom->clks[i]); |
| if (ret < 0) { |
| while (--i >= 0) |
| clk_disable_unprepare(qcom->clks[i]); |
| return ret; |
| } |
| } |
| |
| /* Clear existing events from PHY related to L2 in/out */ |
| dwc3_qcom_setbits(qcom->qscratch_base, PWR_EVNT_IRQ_STAT_REG, |
| PWR_EVNT_LPM_IN_L2_MASK | PWR_EVNT_LPM_OUT_L2_MASK); |
| |
| qcom->is_suspended = false; |
| |
| return 0; |
| } |
| |
| static irqreturn_t qcom_dwc3_resume_irq(int irq, void *data) |
| { |
| struct dwc3_qcom *qcom = data; |
| struct dwc3 *dwc = platform_get_drvdata(qcom->dwc3); |
| |
| /* If pm_suspended then let pm_resume take care of resuming h/w */ |
| if (qcom->pm_suspended) |
| return IRQ_HANDLED; |
| |
| /* |
| * This is safe as role switching is done from a freezable workqueue |
| * and the wakeup interrupts are disabled as part of resume. |
| */ |
| if (dwc3_qcom_is_host(qcom)) |
| pm_runtime_resume(&dwc->xhci->dev); |
| |
| return IRQ_HANDLED; |
| } |
| |
| static void dwc3_qcom_select_utmi_clk(struct dwc3_qcom *qcom) |
| { |
| /* Configure dwc3 to use UTMI clock as PIPE clock not present */ |
| dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG, |
| PIPE_UTMI_CLK_DIS); |
| |
| usleep_range(100, 1000); |
| |
| dwc3_qcom_setbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG, |
| PIPE_UTMI_CLK_SEL | PIPE3_PHYSTATUS_SW); |
| |
| usleep_range(100, 1000); |
| |
| dwc3_qcom_clrbits(qcom->qscratch_base, QSCRATCH_GENERAL_CFG, |
| PIPE_UTMI_CLK_DIS); |
| } |
| |
| static int dwc3_qcom_setup_irq(struct platform_device *pdev) |
| { |
| struct dwc3_qcom *qcom = platform_get_drvdata(pdev); |
| int irq, ret; |
| |
| irq = platform_get_irq_byname(pdev, "hs_phy_irq"); |
| if (irq > 0) { |
| /* Keep wakeup interrupts disabled until suspend */ |
| irq_set_status_flags(irq, IRQ_NOAUTOEN); |
| ret = devm_request_threaded_irq(qcom->dev, irq, NULL, |
| qcom_dwc3_resume_irq, |
| IRQF_ONESHOT, |
| "qcom_dwc3 HS", qcom); |
| if (ret) { |
| dev_err(qcom->dev, "hs_phy_irq failed: %d\n", ret); |
| return ret; |
| } |
| qcom->hs_phy_irq = irq; |
| } |
| |
| irq = platform_get_irq_byname(pdev, "dp_hs_phy_irq"); |
| if (irq > 0) { |
| irq_set_status_flags(irq, IRQ_NOAUTOEN); |
| ret = devm_request_threaded_irq(qcom->dev, irq, NULL, |
| qcom_dwc3_resume_irq, |
| IRQF_ONESHOT, |
| "qcom_dwc3 DP_HS", qcom); |
| if (ret) { |
| dev_err(qcom->dev, "dp_hs_phy_irq failed: %d\n", ret); |
| return ret; |
| } |
| qcom->dp_hs_phy_irq = irq; |
| } |
| |
| irq = platform_get_irq_byname(pdev, "dm_hs_phy_irq"); |
| if (irq > 0) { |
| irq_set_status_flags(irq, IRQ_NOAUTOEN); |
| ret = devm_request_threaded_irq(qcom->dev, irq, NULL, |
| qcom_dwc3_resume_irq, |
| IRQF_ONESHOT, |
| "qcom_dwc3 DM_HS", qcom); |
| if (ret) { |
| dev_err(qcom->dev, "dm_hs_phy_irq failed: %d\n", ret); |
| return ret; |
| } |
| qcom->dm_hs_phy_irq = irq; |
| } |
| |
| irq = platform_get_irq_byname(pdev, "ss_phy_irq"); |
| if (irq > 0) { |
| irq_set_status_flags(irq, IRQ_NOAUTOEN); |
| ret = devm_request_threaded_irq(qcom->dev, irq, NULL, |
| qcom_dwc3_resume_irq, |
| IRQF_ONESHOT, |
| "qcom_dwc3 SS", qcom); |
| if (ret) { |
| dev_err(qcom->dev, "ss_phy_irq failed: %d\n", ret); |
| return ret; |
| } |
| qcom->ss_phy_irq = irq; |
| } |
| |
| return 0; |
| } |
| |
| static int dwc3_qcom_clk_init(struct dwc3_qcom *qcom, int count) |
| { |
| struct device *dev = qcom->dev; |
| struct device_node *np = dev->of_node; |
| int i; |
| |
| qcom->num_clocks = count; |
| |
| if (!count) |
| return 0; |
| |
| qcom->clks = devm_kcalloc(dev, qcom->num_clocks, |
| sizeof(struct clk *), GFP_KERNEL); |
| if (!qcom->clks) |
| return -ENOMEM; |
| |
| for (i = 0; i < qcom->num_clocks; i++) { |
| struct clk *clk; |
| int ret; |
| |
| clk = of_clk_get(np, i); |
| if (IS_ERR(clk)) { |
| while (--i >= 0) |
| clk_put(qcom->clks[i]); |
| return PTR_ERR(clk); |
| } |
| |
| ret = clk_prepare_enable(clk); |
| if (ret < 0) { |
| while (--i >= 0) { |
| clk_disable_unprepare(qcom->clks[i]); |
| clk_put(qcom->clks[i]); |
| } |
| clk_put(clk); |
| |
| return ret; |
| } |
| |
| qcom->clks[i] = clk; |
| } |
| |
| return 0; |
| } |
| |
| static int dwc3_qcom_probe(struct platform_device *pdev) |
| { |
| struct device_node *np = pdev->dev.of_node, *dwc3_np; |
| struct device *dev = &pdev->dev; |
| struct dwc3_qcom *qcom; |
| struct resource *res; |
| int ret, i; |
| bool ignore_pipe_clk; |
| |
| qcom = devm_kzalloc(&pdev->dev, sizeof(*qcom), GFP_KERNEL); |
| if (!qcom) |
| return -ENOMEM; |
| |
| platform_set_drvdata(pdev, qcom); |
| qcom->dev = &pdev->dev; |
| |
| qcom->resets = devm_reset_control_array_get_optional_exclusive(dev); |
| if (IS_ERR(qcom->resets)) { |
| ret = PTR_ERR(qcom->resets); |
| dev_err(&pdev->dev, "failed to get resets, err=%d\n", ret); |
| return ret; |
| } |
| |
| ret = reset_control_assert(qcom->resets); |
| if (ret) { |
| dev_err(&pdev->dev, "failed to assert resets, err=%d\n", ret); |
| return ret; |
| } |
| |
| usleep_range(10, 1000); |
| |
| ret = reset_control_deassert(qcom->resets); |
| if (ret) { |
| dev_err(&pdev->dev, "failed to deassert resets, err=%d\n", ret); |
| goto reset_assert; |
| } |
| |
| ret = dwc3_qcom_clk_init(qcom, of_count_phandle_with_args(np, |
| "clocks", "#clock-cells")); |
| if (ret) { |
| dev_err(dev, "failed to get clocks\n"); |
| goto reset_assert; |
| } |
| |
| res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
| qcom->qscratch_base = devm_ioremap_resource(dev, res); |
| if (IS_ERR(qcom->qscratch_base)) { |
| dev_err(dev, "failed to map qscratch, err=%d\n", ret); |
| ret = PTR_ERR(qcom->qscratch_base); |
| goto clk_disable; |
| } |
| |
| ret = dwc3_qcom_setup_irq(pdev); |
| if (ret) |
| goto clk_disable; |
| |
| dwc3_np = of_get_child_by_name(np, "dwc3"); |
| if (!dwc3_np) { |
| dev_err(dev, "failed to find dwc3 core child\n"); |
| ret = -ENODEV; |
| goto clk_disable; |
| } |
| |
| /* |
| * Disable pipe_clk requirement if specified. Used when dwc3 |
| * operates without SSPHY and only HS/FS/LS modes are supported. |
| */ |
| ignore_pipe_clk = device_property_read_bool(dev, |
| "qcom,select-utmi-as-pipe-clk"); |
| if (ignore_pipe_clk) |
| dwc3_qcom_select_utmi_clk(qcom); |
| |
| ret = of_platform_populate(np, NULL, NULL, dev); |
| if (ret) { |
| dev_err(dev, "failed to register dwc3 core - %d\n", ret); |
| goto clk_disable; |
| } |
| |
| qcom->dwc3 = of_find_device_by_node(dwc3_np); |
| if (!qcom->dwc3) { |
| dev_err(&pdev->dev, "failed to get dwc3 platform device\n"); |
| ret = -ENODEV; |
| goto depopulate; |
| } |
| |
| qcom->mode = usb_get_dr_mode(&qcom->dwc3->dev); |
| |
| /* enable vbus override for device mode */ |
| if (qcom->mode != USB_DR_MODE_HOST) |
| dwc3_qcom_vbus_override_enable(qcom, true); |
| |
| /* register extcon to override sw_vbus on Vbus change later */ |
| ret = dwc3_qcom_register_extcon(qcom); |
| if (ret) |
| goto depopulate; |
| |
| device_init_wakeup(&pdev->dev, 1); |
| qcom->is_suspended = false; |
| pm_runtime_set_active(dev); |
| pm_runtime_enable(dev); |
| pm_runtime_forbid(dev); |
| |
| return 0; |
| |
| depopulate: |
| of_platform_depopulate(&pdev->dev); |
| clk_disable: |
| for (i = qcom->num_clocks - 1; i >= 0; i--) { |
| clk_disable_unprepare(qcom->clks[i]); |
| clk_put(qcom->clks[i]); |
| } |
| reset_assert: |
| reset_control_assert(qcom->resets); |
| |
| return ret; |
| } |
| |
| static int dwc3_qcom_remove(struct platform_device *pdev) |
| { |
| struct dwc3_qcom *qcom = platform_get_drvdata(pdev); |
| struct device *dev = &pdev->dev; |
| int i; |
| |
| of_platform_depopulate(dev); |
| |
| for (i = qcom->num_clocks - 1; i >= 0; i--) { |
| clk_disable_unprepare(qcom->clks[i]); |
| clk_put(qcom->clks[i]); |
| } |
| qcom->num_clocks = 0; |
| |
| reset_control_assert(qcom->resets); |
| |
| pm_runtime_allow(dev); |
| pm_runtime_disable(dev); |
| |
| return 0; |
| } |
| |
| static int __maybe_unused dwc3_qcom_pm_suspend(struct device *dev) |
| { |
| struct dwc3_qcom *qcom = dev_get_drvdata(dev); |
| int ret = 0; |
| |
| ret = dwc3_qcom_suspend(qcom); |
| if (!ret) |
| qcom->pm_suspended = true; |
| |
| return ret; |
| } |
| |
| static int __maybe_unused dwc3_qcom_pm_resume(struct device *dev) |
| { |
| struct dwc3_qcom *qcom = dev_get_drvdata(dev); |
| int ret; |
| |
| ret = dwc3_qcom_resume(qcom); |
| if (!ret) |
| qcom->pm_suspended = false; |
| |
| return ret; |
| } |
| |
| static int __maybe_unused dwc3_qcom_runtime_suspend(struct device *dev) |
| { |
| struct dwc3_qcom *qcom = dev_get_drvdata(dev); |
| |
| return dwc3_qcom_suspend(qcom); |
| } |
| |
| static int __maybe_unused dwc3_qcom_runtime_resume(struct device *dev) |
| { |
| struct dwc3_qcom *qcom = dev_get_drvdata(dev); |
| |
| return dwc3_qcom_resume(qcom); |
| } |
| |
| static const struct dev_pm_ops dwc3_qcom_dev_pm_ops = { |
| SET_SYSTEM_SLEEP_PM_OPS(dwc3_qcom_pm_suspend, dwc3_qcom_pm_resume) |
| SET_RUNTIME_PM_OPS(dwc3_qcom_runtime_suspend, dwc3_qcom_runtime_resume, |
| NULL) |
| }; |
| |
| static const struct of_device_id dwc3_qcom_of_match[] = { |
| { .compatible = "qcom,dwc3" }, |
| { .compatible = "qcom,msm8996-dwc3" }, |
| { .compatible = "qcom,sdm845-dwc3" }, |
| { } |
| }; |
| MODULE_DEVICE_TABLE(of, dwc3_qcom_of_match); |
| |
| static struct platform_driver dwc3_qcom_driver = { |
| .probe = dwc3_qcom_probe, |
| .remove = dwc3_qcom_remove, |
| .driver = { |
| .name = "dwc3-qcom", |
| .pm = &dwc3_qcom_dev_pm_ops, |
| .of_match_table = dwc3_qcom_of_match, |
| }, |
| }; |
| |
| module_platform_driver(dwc3_qcom_driver); |
| |
| MODULE_LICENSE("GPL v2"); |
| MODULE_DESCRIPTION("DesignWare DWC3 QCOM Glue Driver"); |