/*
 * xHCI host controller driver PCI Bus Glue.
 *
 * Copyright (C) 2008 Intel Corp.
 *
 * Author: Sarah Sharp
 * Some code borrowed from the Linux EHCI 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.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/acpi.h>

#include "xhci.h"
#include "xhci-trace.h"

#define SSIC_PORT_NUM           2
#define SSIC_PORT_CFG2          0x880c
#define SSIC_PORT_CFG2_OFFSET   0x30
#define PROG_DONE               (1 << 30)
#define SSIC_PORT_UNUSED        (1 << 31)

/* Device for a quirk */
#define PCI_VENDOR_ID_FRESCO_LOGIC      0x1b73
#define PCI_DEVICE_ID_FRESCO_LOGIC_PDK  0x1000
#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009       0x1009
#define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400       0x1400

#define PCI_VENDOR_ID_ETRON             0x1b6f
#define PCI_DEVICE_ID_EJ168             0x7023

#define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI      0x8c31
#define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI   0x9c31
#define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI        0x9cb1
#define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI             0x22b5
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI         0xa12f
#define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI        0x9d2f
#define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI              0x0aa8
#define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI              0x1aa8
#define PCI_DEVICE_ID_INTEL_APL_XHCI                    0x5aa8
#define PCI_DEVICE_ID_INTEL_DNV_XHCI                    0x19d0

#define PCI_DEVICE_ID_AMD_PROMONTORYA_4                 0x43b9
#define PCI_DEVICE_ID_AMD_PROMONTORYA_3                 0x43ba
#define PCI_DEVICE_ID_AMD_PROMONTORYA_2                 0x43bb
#define PCI_DEVICE_ID_AMD_PROMONTORYA_1                 0x43bc

#define PCI_DEVICE_ID_ASMEDIA_1042A_XHCI                0x1142

static const char hcd_name[] = "xhci_hcd";

static struct hc_driver __read_mostly xhci_pci_hc_driver;

static int xhci_pci_setup(struct usb_hcd *hcd);

static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
        .reset = xhci_pci_setup,
};

/* called after powerup, by probe or system-pm "wakeup" */
static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
{
        /*
         * TODO: Implement finding debug ports later.
         * TODO: see if there are any quirks that need to be added to handle
         * new extended capabilities.
         */

        /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
        if (!pci_set_mwi(pdev))
                xhci_dbg(xhci, "MWI active\n");

        xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
        return 0;
}

static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
{
        struct pci_dev          *pdev = to_pci_dev(dev);

        /* Look for vendor-specific quirks */
        if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
                        (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
                         pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
                if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
                                pdev->revision == 0x0) {
                        xhci->quirks |= XHCI_RESET_EP_QUIRK;
                        xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "QUIRK: Fresco Logic xHC needs configure"
                                " endpoint cmd after reset endpoint");
                }
                if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
                                pdev->revision == 0x4) {
                        xhci->quirks |= XHCI_SLOW_SUSPEND;
                        xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "QUIRK: Fresco Logic xHC revision %u"
                                "must be suspended extra slowly",
                                pdev->revision);
                }
                if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
                        xhci->quirks |= XHCI_BROKEN_STREAMS;
                /* Fresco Logic confirms: all revisions of this chip do not
                 * support MSI, even though some of them claim to in their PCI
                 * capabilities.
                 */
                xhci->quirks |= XHCI_BROKEN_MSI;
                xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "QUIRK: Fresco Logic revision %u "
                                "has broken MSI implementation",
                                pdev->revision);
                xhci->quirks |= XHCI_TRUST_TX_LENGTH;
        }

        if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
                        pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009)
                xhci->quirks |= XHCI_BROKEN_STREAMS;

        if (pdev->vendor == PCI_VENDOR_ID_NEC)
                xhci->quirks |= XHCI_NEC_HOST;

        if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
                xhci->quirks |= XHCI_AMD_0x96_HOST;

        /* AMD PLL quirk */
        if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
                xhci->quirks |= XHCI_AMD_PLL_FIX;

        if (pdev->vendor == PCI_VENDOR_ID_AMD)
                xhci->quirks |= XHCI_TRUST_TX_LENGTH;

        if ((pdev->vendor == PCI_VENDOR_ID_AMD) &&
                ((pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_4) ||
                (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_3) ||
                (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_2) ||
                (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_1)))
                xhci->quirks |= XHCI_U2_DISABLE_WAKE;

        if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
                xhci->quirks |= XHCI_LPM_SUPPORT;
                xhci->quirks |= XHCI_INTEL_HOST;
                xhci->quirks |= XHCI_AVOID_BEI;
        }
        if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
                        pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
                xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
                xhci->limit_active_eps = 64;
                xhci->quirks |= XHCI_SW_BW_CHECKING;
                /*
                 * PPT desktop boards DH77EB and DH77DF will power back on after
                 * a few seconds of being shutdown.  The fix for this is to
                 * switch the ports from xHCI to EHCI on shutdown.  We can't use
                 * DMI information to find those particular boards (since each
                 * vendor will change the board name), so we have to key off all
                 * PPT chipsets.
                 */
                xhci->quirks |= XHCI_SPURIOUS_REBOOT;
        }
        if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
                (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI)) {
                xhci->quirks |= XHCI_SPURIOUS_REBOOT;
                xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
        }
        if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
                (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
                 pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI)) {
                xhci->quirks |= XHCI_PME_STUCK_QUIRK;
        }
        if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
                 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
                xhci->quirks |= XHCI_SSIC_PORT_UNUSED;
        }
        if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
            (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
             pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
             pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI))
                xhci->quirks |= XHCI_MISSING_CAS;

        if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
                        pdev->device == PCI_DEVICE_ID_EJ168) {
                xhci->quirks |= XHCI_RESET_ON_RESUME;
                xhci->quirks |= XHCI_TRUST_TX_LENGTH;
                xhci->quirks |= XHCI_BROKEN_STREAMS;
        }
        if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
                        pdev->device == 0x0015)
                xhci->quirks |= XHCI_RESET_ON_RESUME;
        if (pdev->vendor == PCI_VENDOR_ID_VIA)
                xhci->quirks |= XHCI_RESET_ON_RESUME;

        /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
        if (pdev->vendor == PCI_VENDOR_ID_VIA &&
                        pdev->device == 0x3432)
                xhci->quirks |= XHCI_BROKEN_STREAMS;

        if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
                        pdev->device == 0x1042)
                xhci->quirks |= XHCI_BROKEN_STREAMS;
        if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
                        pdev->device == 0x1142)
                xhci->quirks |= XHCI_TRUST_TX_LENGTH;

        if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
                pdev->device == PCI_DEVICE_ID_ASMEDIA_1042A_XHCI)
                xhci->quirks |= XHCI_ASMEDIA_MODIFY_FLOWCONTROL;

        if (pdev->vendor == PCI_VENDOR_ID_TI && pdev->device == 0x8241)
                xhci->quirks |= XHCI_LIMIT_ENDPOINT_INTERVAL_7;

        if (xhci->quirks & XHCI_RESET_ON_RESUME)
                xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "QUIRK: Resetting on resume");
}

#ifdef CONFIG_ACPI
static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
{
        static const guid_t intel_dsm_guid =
                GUID_INIT(0xac340cb7, 0xe901, 0x45bf,
                          0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23);
        union acpi_object *obj;

        obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), &intel_dsm_guid, 3, 1,
                                NULL);
        ACPI_FREE(obj);
}
#else
static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
#endif /* CONFIG_ACPI */

/* called during probe() after chip reset completes */
static int xhci_pci_setup(struct usb_hcd *hcd)
{
        struct xhci_hcd         *xhci;
        struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
        int                     retval;

        xhci = hcd_to_xhci(hcd);
        if (!xhci->sbrn)
                pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);

        retval = xhci_gen_setup(hcd, xhci_pci_quirks);
        if (retval)
                return retval;

        if (!usb_hcd_is_primary_hcd(hcd))
                return 0;

        xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);

        /* Find any debug ports */
        return xhci_pci_reinit(xhci, pdev);
}

/*
 * We need to register our own PCI probe function (instead of the USB core's
 * function) in order to create a second roothub under xHCI.
 */
static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
{
        int retval;
        struct xhci_hcd *xhci;
        struct hc_driver *driver;
        struct usb_hcd *hcd;

        driver = (struct hc_driver *)id->driver_data;

        /* For some HW implementation, a XHCI reset is just not enough... */
        if (usb_xhci_needs_pci_reset(dev)) {
                dev_info(&dev->dev, "Resetting\n");
                if (pci_reset_function_locked(dev))
                        dev_warn(&dev->dev, "Reset failed");
        }

        /* Prevent runtime suspending between USB-2 and USB-3 initialization */
        pm_runtime_get_noresume(&dev->dev);

        /* Register the USB 2.0 roothub.
         * FIXME: USB core must know to register the USB 2.0 roothub first.
         * This is sort of silly, because we could just set the HCD driver flags
         * to say USB 2.0, but I'm not sure what the implications would be in
         * the other parts of the HCD code.
         */
        retval = usb_hcd_pci_probe(dev, id);

        if (retval)
                goto put_runtime_pm;

        /* USB 2.0 roothub is stored in the PCI device now. */
        hcd = dev_get_drvdata(&dev->dev);
        xhci = hcd_to_xhci(hcd);
        xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
                                pci_name(dev), hcd);
        if (!xhci->shared_hcd) {
                retval = -ENOMEM;
                goto dealloc_usb2_hcd;
        }

        retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
                        IRQF_SHARED);
        if (retval)
                goto put_usb3_hcd;
        /* Roothub already marked as USB 3.0 speed */

        if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
                        HCC_MAX_PSA(xhci->hcc_params) >= 4)
                xhci->shared_hcd->can_do_streams = 1;

        if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
                xhci_pme_acpi_rtd3_enable(dev);

        /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
        pm_runtime_put_noidle(&dev->dev);

        return 0;

put_usb3_hcd:
        usb_put_hcd(xhci->shared_hcd);
dealloc_usb2_hcd:
        usb_hcd_pci_remove(dev);
put_runtime_pm:
        pm_runtime_put_noidle(&dev->dev);
        return retval;
}

static void xhci_pci_remove(struct pci_dev *dev)
{
        struct xhci_hcd *xhci;

        xhci = hcd_to_xhci(pci_get_drvdata(dev));
        xhci->xhc_state |= XHCI_STATE_REMOVING;
        if (xhci->shared_hcd) {
                usb_remove_hcd(xhci->shared_hcd);
                usb_put_hcd(xhci->shared_hcd);
        }

        /* Workaround for spurious wakeups at shutdown with HSW */
        if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
                pci_set_power_state(dev, PCI_D3hot);

        usb_hcd_pci_remove(dev);
}

#ifdef CONFIG_PM
/*
 * In some Intel xHCI controllers, in order to get D3 working,
 * through a vendor specific SSIC CONFIG register at offset 0x883c,
 * SSIC PORT need to be marked as "unused" before putting xHCI
 * into D3. After D3 exit, the SSIC port need to be marked as "used".
 * Without this change, xHCI might not enter D3 state.
 */
static void xhci_ssic_port_unused_quirk(struct usb_hcd *hcd, bool suspend)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        u32 val;
        void __iomem *reg;
        int i;

        for (i = 0; i < SSIC_PORT_NUM; i++) {
                reg = (void __iomem *) xhci->cap_regs +
                                SSIC_PORT_CFG2 +
                                i * SSIC_PORT_CFG2_OFFSET;

                /* Notify SSIC that SSIC profile programming is not done. */
                val = readl(reg) & ~PROG_DONE;
                writel(val, reg);

                /* Mark SSIC port as unused(suspend) or used(resume) */
                val = readl(reg);
                if (suspend)
                        val |= SSIC_PORT_UNUSED;
                else
                        val &= ~SSIC_PORT_UNUSED;
                writel(val, reg);

                /* Notify SSIC that SSIC profile programming is done */
                val = readl(reg) | PROG_DONE;
                writel(val, reg);
                readl(reg);
        }
}

/*
 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
 */
static void xhci_pme_quirk(struct usb_hcd *hcd)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        void __iomem *reg;
        u32 val;

        reg = (void __iomem *) xhci->cap_regs + 0x80a4;
        val = readl(reg);
        writel(val | BIT(28), reg);
        readl(reg);
}

static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
        int                     ret;

        /*
         * Systems with the TI redriver that loses port status change events
         * need to have the registers polled during D3, so avoid D3cold.
         */
        if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
                pci_d3cold_disable(pdev);

        if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
                xhci_pme_quirk(hcd);

        if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
                xhci_ssic_port_unused_quirk(hcd, true);

        ret = xhci_suspend(xhci, do_wakeup);
        if (ret && (xhci->quirks & XHCI_SSIC_PORT_UNUSED))
                xhci_ssic_port_unused_quirk(hcd, false);

        return ret;
}

static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
{
        struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
        struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
        int                     retval = 0;

        /* The BIOS on systems with the Intel Panther Point chipset may or may
         * not support xHCI natively.  That means that during system resume, it
         * may switch the ports back to EHCI so that users can use their
         * keyboard to select a kernel from GRUB after resume from hibernate.
         *
         * The BIOS is supposed to remember whether the OS had xHCI ports
         * enabled before resume, and switch the ports back to xHCI when the
         * BIOS/OS semaphore is written, but we all know we can't trust BIOS
         * writers.
         *
         * Unconditionally switch the ports back to xHCI after a system resume.
         * It should not matter whether the EHCI or xHCI controller is
         * resumed first. It's enough to do the switchover in xHCI because
         * USB core won't notice anything as the hub driver doesn't start
         * running again until after all the devices (including both EHCI and
         * xHCI host controllers) have been resumed.
         */

        if (pdev->vendor == PCI_VENDOR_ID_INTEL)
                usb_enable_intel_xhci_ports(pdev);

        if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
                xhci_ssic_port_unused_quirk(hcd, false);

        if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
                xhci_pme_quirk(hcd);

        retval = xhci_resume(xhci, hibernated);
        return retval;
}
#endif /* CONFIG_PM */

/*-------------------------------------------------------------------------*/

/* PCI driver selection metadata; PCI hotplugging uses this */
static const struct pci_device_id pci_ids[] = { {
        /* handle any USB 3.0 xHCI controller */
        PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
        .driver_data =  (unsigned long) &xhci_pci_hc_driver,
        },
        { /* end: all zeroes */ }
};
MODULE_DEVICE_TABLE(pci, pci_ids);

/* pci driver glue; this is a "new style" PCI driver module */
static struct pci_driver xhci_pci_driver = {
        .name =         (char *) hcd_name,
        .id_table =     pci_ids,

        .probe =        xhci_pci_probe,
        .remove =       xhci_pci_remove,
        /* suspend and resume implemented later */

        .shutdown =     usb_hcd_pci_shutdown,
#ifdef CONFIG_PM
        .driver = {
                .pm = &usb_hcd_pci_pm_ops
        },
#endif
};

static int __init xhci_pci_init(void)
{
        xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
#ifdef CONFIG_PM
        xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
        xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
#endif
        return pci_register_driver(&xhci_pci_driver);
}
module_init(xhci_pci_init);

static void __exit xhci_pci_exit(void)
{
        pci_unregister_driver(&xhci_pci_driver);
}
module_exit(xhci_pci_exit);

MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
MODULE_LICENSE("GPL");