/* * xhci-plat.c - xHCI host controller driver platform Bus Glue. * * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com * Author: Sebastian Andrzej Siewior * * A lot of code borrowed from the Linux xHCI driver. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. */ #include #include #include #include #include #include #include #include #include #include #ifdef CONFIG_SND_EXYNOS_USB_AUDIO #include #endif #include "xhci.h" #include "xhci-plat.h" #include "xhci-mvebu.h" #include "xhci-rcar.h" static struct hc_driver __read_mostly xhci_plat_hc_driver; static int xhci_plat_setup(struct usb_hcd *hcd); static int xhci_plat_start(struct usb_hcd *hcd); void __iomem *usb3_portsc; static u32 pp_set_delayed; #define PORTSC_OFFSET 0x430 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { .extra_priv_size = sizeof(struct xhci_plat_priv), .reset = xhci_plat_setup, .start = xhci_plat_start, }; static void xhci_priv_plat_start(struct usb_hcd *hcd) { struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); if (priv->plat_start) priv->plat_start(hcd); } static int xhci_priv_init_quirk(struct usb_hcd *hcd) { struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); if (!priv->init_quirk) return 0; return priv->init_quirk(hcd); } static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) { /* * As of now platform drivers don't provide MSI support so we ensure * here that the generic code does not try to make a pci_dev from our * dev struct in order to setup MSI */ xhci->quirks |= XHCI_PLAT; } /* called during probe() after chip reset completes */ static int xhci_plat_setup(struct usb_hcd *hcd) { int ret; ret = xhci_priv_init_quirk(hcd); if (ret) return ret; ret = xhci_gen_setup(hcd, xhci_plat_quirks); /* * DWC3 WORKAROUND: xhci reset clears PHY CR port settings, * so USB3.0 PHY should be tuned again. */ if (hcd->phy) phy_tune(hcd->phy, OTG_STATE_A_HOST); return ret; } static int xhci_plat_start(struct usb_hcd *hcd) { xhci_priv_plat_start(hcd); return xhci_run(hcd); } static ssize_t xhci_plat_show_ss_compliance(struct device *dev, struct device_attribute *attr, char *buf) { struct usb_hcd *hcd = dev_get_drvdata(dev); u32 reg; void __iomem *reg_base; reg_base = hcd->regs; reg = readl(reg_base + PORTSC_OFFSET); return snprintf(buf, PAGE_SIZE, "0x%x\n", reg); } static ssize_t xhci_platg_store_ss_compliance(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) { struct usb_hcd *hcd = dev_get_drvdata(dev); int value; u32 reg; void __iomem *reg_base; if (sscanf(buf, "%d", &value) != 1) return -EINVAL; reg_base = hcd->regs; if (value == 1) { /* PORTSC PLS is set to 10, LWS to 1 */ reg = readl(reg_base + PORTSC_OFFSET); reg &= ~((0xF << 5) | (1 << 16)); reg |= (10 << 5) | (1 << 16); writel(reg, reg_base + PORTSC_OFFSET); pr_info("Super speed host compliance enabled portsc 0x%x\n", reg); } else pr_info("Only 1 is allowed for input value\n"); return n; } static DEVICE_ATTR(ss_compliance, S_IWUSR | S_IRUSR | S_IRGRP, xhci_plat_show_ss_compliance, xhci_platg_store_ss_compliance); static ssize_t xhci_plat_show_l2_state(struct device *dev, struct device_attribute *attr, char *buf) { struct usb_hcd *hcd = dev_get_drvdata(dev); struct xhci_hcd *xhci = hcd_to_xhci(hcd); return snprintf(buf, PAGE_SIZE, "%d\n", xhci->l2_state); } static DEVICE_ATTR(l2_state, S_IRUSR | S_IRGRP | S_IROTH, xhci_plat_show_l2_state, NULL); static struct attribute *exynos_xhci_attributes[] = { &dev_attr_l2_state.attr, &dev_attr_ss_compliance.attr, NULL }; static const struct attribute_group xhci_plat_attr_group = { .attrs = exynos_xhci_attributes, }; #ifdef CONFIG_OF static const struct xhci_plat_priv xhci_plat_marvell_armada = { .init_quirk = xhci_mvebu_mbus_init_quirk, }; static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, .init_quirk = xhci_rcar_init_quirk, .plat_start = xhci_rcar_start, .resume_quirk = xhci_rcar_resume_quirk, }; static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { .init_quirk = xhci_rcar_init_quirk, .plat_start = xhci_rcar_start, .resume_quirk = xhci_rcar_resume_quirk, }; static const struct of_device_id usb_xhci_of_match[] = { { .compatible = "generic-xhci", }, { .compatible = "xhci-platform", }, { .compatible = "marvell,armada-375-xhci", .data = &xhci_plat_marvell_armada, }, { .compatible = "marvell,armada-380-xhci", .data = &xhci_plat_marvell_armada, }, { .compatible = "renesas,xhci-r8a7790", .data = &xhci_plat_renesas_rcar_gen2, }, { .compatible = "renesas,xhci-r8a7791", .data = &xhci_plat_renesas_rcar_gen2, }, { .compatible = "renesas,xhci-r8a7793", .data = &xhci_plat_renesas_rcar_gen2, }, { .compatible = "renesas,xhci-r8a7795", .data = &xhci_plat_renesas_rcar_gen3, }, { .compatible = "renesas,xhci-r8a7796", .data = &xhci_plat_renesas_rcar_gen3, }, { .compatible = "renesas,rcar-gen2-xhci", .data = &xhci_plat_renesas_rcar_gen2, }, { .compatible = "renesas,rcar-gen3-xhci", .data = &xhci_plat_renesas_rcar_gen3, }, {}, }; MODULE_DEVICE_TABLE(of, usb_xhci_of_match); #endif void xhci_portsc_power_off(void __iomem *portsc, u32 on) { u32 reg; reg = readl(portsc); if (on) reg |= PORT_POWER; else reg &= ~PORT_POWER; writel(reg, portsc); reg = readl(portsc); pr_info("%s, reg = 0x%x addr = %p\n", __func__, reg, portsc); } int xhci_portsc_set(u32 on) { if (usb3_portsc != NULL) { xhci_portsc_power_off(usb3_portsc, 0); pp_set_delayed = 0; return 0; } pp_set_delayed = 1; pr_info("%s, usb3_portsc is NULL\n", __func__); return -EIO; } static int xhci_plat_probe(struct platform_device *pdev) { struct device *parent = pdev->dev.parent; const struct of_device_id *match; const struct hc_driver *driver; struct device *sysdev; struct xhci_hcd *xhci; struct resource *res; struct usb_hcd *hcd; struct clk *clk; int ret; int irq; struct wake_lock *wakelock; int value; dev_info(&pdev->dev, "XHCI PLAT START\n"); wakelock = kzalloc(sizeof(struct wake_lock), GFP_KERNEL); wake_lock_init(wakelock, WAKE_LOCK_SUSPEND, dev_name(&pdev->dev)); wake_lock(wakelock); if (usb_disabled()) return -ENODEV; driver = &xhci_plat_hc_driver; irq = platform_get_irq(pdev, 0); if (irq < 0) return irq; /* * sysdev must point to a device that is known to the system firmware * or PCI hardware. We handle these three cases here: * 1. xhci_plat comes from firmware * 2. xhci_plat is child of a device from firmware (dwc3-plat) * 3. xhci_plat is grandchild of a pci device (dwc3-pci) */ for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) { if (is_of_node(sysdev->fwnode) || is_acpi_device_node(sysdev->fwnode)) break; #ifdef CONFIG_PCI else if (sysdev->bus == &pci_bus_type) break; #endif } if (!sysdev) sysdev = &pdev->dev; /* Try to set 64-bit DMA first */ if (WARN_ON(!sysdev->dma_mask)) /* Platform did not initialize dma_mask */ ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); else ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ if (ret) { ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32)); if (ret) return ret; } ret = pm_runtime_set_active(&pdev->dev); if (ret != 0) { pr_err("USB can't enable runtime pm (%d)\n", ret); goto runtime_pm_err; } pm_runtime_enable(&pdev->dev); pm_runtime_get_noresume(&pdev->dev); hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, dev_name(&pdev->dev), NULL); if (!hcd) { ret = -ENOMEM; goto disable_runtime; } res = platform_get_resource(pdev, IORESOURCE_MEM, 0); hcd->regs = devm_ioremap_resource(&pdev->dev, res); if (IS_ERR(hcd->regs)) { ret = PTR_ERR(hcd->regs); goto put_hcd; } hcd->rsrc_start = res->start; hcd->rsrc_len = resource_size(res); usb3_portsc = hcd->regs + PORTSC_OFFSET; pr_info("get usb3_portsc addr = %p pp_set = %d\n", usb3_portsc, pp_set_delayed); if (pp_set_delayed) { xhci_portsc_power_off(usb3_portsc, 0); pp_set_delayed = 0; } /* Get USB2.0 PHY for main hcd */ if (parent) { hcd->phy = devm_phy_get(parent, "usb2-phy"); if (IS_ERR_OR_NULL(hcd->phy)) { hcd->phy = NULL; dev_err(&pdev->dev, "%s: failed to get phy\n", __func__); } } /* * Not all platforms have a clk so it is not an error if the * clock does not exists. */ clk = devm_clk_get(&pdev->dev, NULL); if (!IS_ERR(clk)) { ret = clk_prepare_enable(clk); if (ret) goto put_hcd; } else if (PTR_ERR(clk) == -EPROBE_DEFER) { ret = -EPROBE_DEFER; goto put_hcd; } xhci = hcd_to_xhci(hcd); match = of_match_node(usb_xhci_of_match, pdev->dev.of_node); if (match) { const struct xhci_plat_priv *priv_match = match->data; struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); /* Just copy data for now */ if (priv_match) *priv = *priv_match; } device_wakeup_enable(hcd->self.controller); xhci->clk = clk; xhci->wakelock = wakelock; xhci->main_hcd = hcd; xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, dev_name(&pdev->dev), hcd); if (!xhci->shared_hcd) { ret = -ENOMEM; goto disable_clk; } if (device_property_read_bool(sysdev, "usb3-lpm-capable")) xhci->quirks |= XHCI_LPM_SUPPORT; if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped")) xhci->quirks |= XHCI_BROKEN_PORT_PED; hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0); if (IS_ERR(hcd->usb_phy)) { ret = PTR_ERR(hcd->usb_phy); if (ret == -EPROBE_DEFER) goto put_usb3_hcd; hcd->usb_phy = NULL; } else { ret = usb_phy_init(hcd->usb_phy); if (ret) goto put_usb3_hcd; } /* Get USB3.0 PHY to tune the PHY */ if (parent) { xhci->shared_hcd->phy = devm_phy_get(parent, "usb3-phy"); if (IS_ERR_OR_NULL(hcd->phy)) { hcd->phy = NULL; dev_err(&pdev->dev, "%s: failed to get phy\n", __func__); } } ret = of_property_read_u32(parent->of_node, "xhci_l2_support", &value); if (ret == 0 && value == 1) xhci->quirks |= XHCI_L2_SUPPORT; else { dev_err(&pdev->dev, "can't get xhci l2 support, error = %d\n", ret); } ret = usb_add_hcd(hcd, irq, IRQF_SHARED); if (ret) goto disable_usb_phy; if (HCC_MAX_PSA(xhci->hcc_params) >= 4) xhci->shared_hcd->can_do_streams = 1; ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); if (ret) goto dealloc_usb2_hcd; #ifdef CONFIG_SND_EXYNOS_USB_AUDIO ret = of_property_read_u32(parent->of_node, "usb_audio_offloading", &value); if (ret == 0 && value == 1) { ret = exynos_usb_audio_init(parent, pdev); if (ret) { dev_err(&pdev->dev, "USB Audio INIT fail\n"); return ret; } else { dev_info(&pdev->dev, "USB Audio offloading is supported\n"); } } else { dev_err(&pdev->dev, "can't get audio support, error = %d\n", ret); return ret; } xhci->out_dma = xhci_data.out_data_dma; xhci->out_addr = xhci_data.out_data_addr; xhci->in_dma = xhci_data.in_data_dma; xhci->in_addr = xhci_data.in_data_addr; #endif ret = sysfs_create_group(&pdev->dev.kobj, &xhci_plat_attr_group); if (ret) dev_err(&pdev->dev, "failed to create xhci-plat attributes\n"); device_enable_async_suspend(&pdev->dev); pm_runtime_put_noidle(&pdev->dev); /* * Prevent runtime pm from being on as default, users should enable * runtime pm using power/control in sysfs. */ pm_runtime_forbid(&pdev->dev); return 0; dealloc_usb2_hcd: usb_remove_hcd(hcd); disable_usb_phy: usb_phy_shutdown(hcd->usb_phy); put_usb3_hcd: usb_put_hcd(xhci->shared_hcd); disable_clk: if (!IS_ERR(clk)) clk_disable_unprepare(clk); put_hcd: usb_put_hcd(hcd); disable_runtime: pm_runtime_put_noidle(&pdev->dev); pm_runtime_disable(&pdev->dev); runtime_pm_err: return ret; } static int xhci_plat_remove(struct platform_device *dev) { struct device *parent = dev->dev.parent; struct usb_hcd *hcd = platform_get_drvdata(dev); struct xhci_hcd *xhci = hcd_to_xhci(hcd); struct clk *clk = xhci->clk; dev_info(&dev->dev, "XHCI PLAT REMOVE\n"); usb3_portsc = NULL; pp_set_delayed = 0; #if defined(CONFIG_USB_HOST_SAMSUNG_FEATURE) pr_info("%s\n", __func__); /* In order to prevent kernel panic */ if (!pm_runtime_suspended(&xhci->shared_hcd->self.root_hub->dev)) { pr_info("%s, shared_hcd pm_runtime_forbid\n", __func__); pm_runtime_forbid(&xhci->shared_hcd->self.root_hub->dev); } if (!pm_runtime_suspended(&xhci->main_hcd->self.root_hub->dev)) { pr_info("%s, main_hcd pm_runtime_forbid\n", __func__); pm_runtime_forbid(&xhci->main_hcd->self.root_hub->dev); } #endif xhci->xhc_state |= XHCI_STATE_REMOVING; dev_info(&dev->dev, "WAKE UNLOCK\n"); wake_unlock(xhci->wakelock); wake_lock_destroy(xhci->wakelock); usb_remove_hcd(xhci->shared_hcd); usb_phy_shutdown(hcd->usb_phy); /* * In usb_remove_hcd, phy_exit is called if phy is not NULL. * However, in the case that PHY was turn on or off as runtime PM, * PHY sould not exit at this time. So, to prevent the PHY exit, * PHY pointer have to be NULL. */ if (parent && hcd->phy) hcd->phy = NULL; usb_remove_hcd(hcd); usb_put_hcd(xhci->shared_hcd); if (!IS_ERR(clk)) clk_disable_unprepare(clk); usb_put_hcd(hcd); pm_runtime_set_suspended(&dev->dev); pm_runtime_disable(&dev->dev); return 0; } static int __maybe_unused xhci_plat_suspend(struct device *dev) { /* *struct usb_hcd *hcd = dev_get_drvdata(dev); *struct xhci_hcd *xhci = hcd_to_xhci(hcd); *int ret; */ pr_info("[%s] \n",__func__); /* * xhci_suspend() needs `do_wakeup` to know whether host is allowed * to do wakeup during suspend. Since xhci_plat_suspend is currently * only designed for system suspend, device_may_wakeup() is enough * to dertermine whether host is allowed to do wakeup. Need to * reconsider this when xhci_plat_suspend enlarges its scope, e.g., * also applies to runtime suspend. */ /* *ret = xhci_suspend(xhci, device_may_wakeup(dev)); * *if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) * clk_disable_unprepare(xhci->clk); */ return 0; } static int __maybe_unused xhci_plat_resume(struct device *dev) { /* *struct usb_hcd *hcd = dev_get_drvdata(dev); *struct xhci_hcd *xhci = hcd_to_xhci(hcd); *int ret; */ pr_info("[%s] \n",__func__); /* *if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) * clk_prepare_enable(xhci->clk); * *ret = xhci_priv_resume_quirk(hcd); *if (ret) * return ret; * *return xhci_resume(xhci, 0); */ return 0; } static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) { struct usb_hcd *hcd = dev_get_drvdata(dev); struct xhci_hcd *xhci = hcd_to_xhci(hcd); return xhci_suspend(xhci, true); } static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) { struct usb_hcd *hcd = dev_get_drvdata(dev); struct xhci_hcd *xhci = hcd_to_xhci(hcd); return xhci_resume(xhci, 0); } static const struct dev_pm_ops xhci_plat_pm_ops = { SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, xhci_plat_runtime_resume, NULL) }; static const struct acpi_device_id usb_xhci_acpi_match[] = { /* XHCI-compliant USB Controller */ { "PNP0D10", }, { } }; MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); static struct platform_driver usb_xhci_driver = { .probe = xhci_plat_probe, .remove = xhci_plat_remove, .driver = { .name = "xhci-hcd", .pm = &xhci_plat_pm_ops, .of_match_table = of_match_ptr(usb_xhci_of_match), .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), }, }; MODULE_ALIAS("platform:xhci-hcd"); static int __init xhci_plat_init(void) { xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); return platform_driver_register(&usb_xhci_driver); } module_init(xhci_plat_init); static void __exit xhci_plat_exit(void) { platform_driver_unregister(&usb_xhci_driver); } module_exit(xhci_plat_exit); MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); MODULE_LICENSE("GPL");