| /* |
| * Copyright (c) 2012-2017 Qualcomm Atheros, Inc. |
| * |
| * Permission to use, copy, modify, and/or distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
| * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| #include <linux/module.h> |
| #include <linux/pci.h> |
| #include <linux/moduleparam.h> |
| #include <linux/interrupt.h> |
| #include <linux/suspend.h> |
| #include "wil6210.h" |
| #include <linux/rtnetlink.h> |
| |
| static bool use_msi = true; |
| module_param(use_msi, bool, 0444); |
| MODULE_PARM_DESC(use_msi, " Use MSI interrupt, default - true"); |
| |
| static bool ftm_mode; |
| module_param(ftm_mode, bool, 0444); |
| MODULE_PARM_DESC(ftm_mode, " Set factory test mode, default - false"); |
| |
| #ifdef CONFIG_PM |
| #ifdef CONFIG_PM_SLEEP |
| static int wil6210_pm_notify(struct notifier_block *notify_block, |
| unsigned long mode, void *unused); |
| #endif /* CONFIG_PM_SLEEP */ |
| #endif /* CONFIG_PM */ |
| |
| static |
| void wil_set_capabilities(struct wil6210_priv *wil) |
| { |
| const char *wil_fw_name; |
| u32 jtag_id = wil_r(wil, RGF_USER_JTAG_DEV_ID); |
| u8 chip_revision = (wil_r(wil, RGF_USER_REVISION_ID) & |
| RGF_USER_REVISION_ID_MASK); |
| |
| bitmap_zero(wil->hw_capabilities, hw_capability_last); |
| bitmap_zero(wil->fw_capabilities, WMI_FW_CAPABILITY_MAX); |
| wil->wil_fw_name = ftm_mode ? WIL_FW_NAME_FTM_DEFAULT : |
| WIL_FW_NAME_DEFAULT; |
| wil->chip_revision = chip_revision; |
| |
| switch (jtag_id) { |
| case JTAG_DEV_ID_SPARROW: |
| switch (chip_revision) { |
| case REVISION_ID_SPARROW_D0: |
| wil->hw_name = "Sparrow D0"; |
| wil->hw_version = HW_VER_SPARROW_D0; |
| wil_fw_name = ftm_mode ? WIL_FW_NAME_FTM_SPARROW_PLUS : |
| WIL_FW_NAME_SPARROW_PLUS; |
| |
| if (wil_fw_verify_file_exists(wil, wil_fw_name)) |
| wil->wil_fw_name = wil_fw_name; |
| break; |
| case REVISION_ID_SPARROW_B0: |
| wil->hw_name = "Sparrow B0"; |
| wil->hw_version = HW_VER_SPARROW_B0; |
| break; |
| default: |
| wil->hw_name = "Unknown"; |
| wil->hw_version = HW_VER_UNKNOWN; |
| break; |
| } |
| break; |
| default: |
| wil_err(wil, "Unknown board hardware, chip_id 0x%08x, chip_revision 0x%08x\n", |
| jtag_id, chip_revision); |
| wil->hw_name = "Unknown"; |
| wil->hw_version = HW_VER_UNKNOWN; |
| } |
| |
| wil_info(wil, "Board hardware is %s\n", wil->hw_name); |
| |
| /* extract FW capabilities from file without loading the FW */ |
| wil_request_firmware(wil, wil->wil_fw_name, false); |
| |
| if (test_bit(WMI_FW_CAPABILITY_RSSI_REPORTING, wil->fw_capabilities)) |
| wil_to_wiphy(wil)->signal_type = CFG80211_SIGNAL_TYPE_MBM; |
| } |
| |
| void wil_disable_irq(struct wil6210_priv *wil) |
| { |
| disable_irq(wil->pdev->irq); |
| } |
| |
| void wil_enable_irq(struct wil6210_priv *wil) |
| { |
| enable_irq(wil->pdev->irq); |
| } |
| |
| /* Bus ops */ |
| static int wil_if_pcie_enable(struct wil6210_priv *wil) |
| { |
| struct pci_dev *pdev = wil->pdev; |
| int rc; |
| /* on platforms with buggy ACPI, pdev->msi_enabled may be set to |
| * allow pci_enable_device to work. This indicates INTx was not routed |
| * and only MSI should be used |
| */ |
| int msi_only = pdev->msi_enabled; |
| bool _use_msi = use_msi; |
| bool wmi_only = test_bit(WMI_FW_CAPABILITY_WMI_ONLY, |
| wil->fw_capabilities); |
| |
| wil_dbg_misc(wil, "if_pcie_enable, wmi_only %d\n", wmi_only); |
| |
| pci_set_master(pdev); |
| |
| wil_dbg_misc(wil, "Setup %s interrupt\n", use_msi ? "MSI" : "INTx"); |
| |
| if (use_msi && pci_enable_msi(pdev)) { |
| wil_err(wil, "pci_enable_msi failed, use INTx\n"); |
| _use_msi = false; |
| } |
| |
| if (!_use_msi && msi_only) { |
| wil_err(wil, "Interrupt pin not routed, unable to use INTx\n"); |
| rc = -ENODEV; |
| goto stop_master; |
| } |
| |
| rc = wil6210_init_irq(wil, pdev->irq, _use_msi); |
| if (rc) |
| goto stop_master; |
| |
| /* need reset here to obtain MAC or in case of WMI-only FW, full reset |
| * and fw loading takes place |
| */ |
| mutex_lock(&wil->mutex); |
| rc = wil_reset(wil, wmi_only); |
| mutex_unlock(&wil->mutex); |
| if (rc) |
| goto release_irq; |
| |
| return 0; |
| |
| release_irq: |
| wil6210_fini_irq(wil, pdev->irq); |
| /* safe to call if no MSI */ |
| pci_disable_msi(pdev); |
| stop_master: |
| pci_clear_master(pdev); |
| return rc; |
| } |
| |
| static int wil_if_pcie_disable(struct wil6210_priv *wil) |
| { |
| struct pci_dev *pdev = wil->pdev; |
| |
| wil_dbg_misc(wil, "if_pcie_disable\n"); |
| |
| pci_clear_master(pdev); |
| /* disable and release IRQ */ |
| wil6210_fini_irq(wil, pdev->irq); |
| /* safe to call if no MSI */ |
| pci_disable_msi(pdev); |
| /* TODO: disable HW */ |
| |
| return 0; |
| } |
| |
| static int wil_platform_rop_ramdump(void *wil_handle, void *buf, uint32_t size) |
| { |
| struct wil6210_priv *wil = wil_handle; |
| |
| if (!wil) |
| return -EINVAL; |
| |
| return wil_fw_copy_crash_dump(wil, buf, size); |
| } |
| |
| static int wil_platform_rop_fw_recovery(void *wil_handle) |
| { |
| struct wil6210_priv *wil = wil_handle; |
| |
| if (!wil) |
| return -EINVAL; |
| |
| wil_fw_error_recovery(wil); |
| |
| return 0; |
| } |
| |
| static void wil_platform_ops_uninit(struct wil6210_priv *wil) |
| { |
| if (wil->platform_ops.uninit) |
| wil->platform_ops.uninit(wil->platform_handle); |
| memset(&wil->platform_ops, 0, sizeof(wil->platform_ops)); |
| } |
| |
| static int wil_pcie_probe(struct pci_dev *pdev, const struct pci_device_id *id) |
| { |
| struct wil6210_priv *wil; |
| struct device *dev = &pdev->dev; |
| int rc; |
| const struct wil_platform_rops rops = { |
| .ramdump = wil_platform_rop_ramdump, |
| .fw_recovery = wil_platform_rop_fw_recovery, |
| }; |
| u32 bar_size = pci_resource_len(pdev, 0); |
| |
| /* check HW */ |
| dev_info(&pdev->dev, WIL_NAME |
| " device found [%04x:%04x] (rev %x) bar size 0x%x\n", |
| (int)pdev->vendor, (int)pdev->device, (int)pdev->revision, |
| bar_size); |
| |
| if ((bar_size < WIL6210_MIN_MEM_SIZE) || |
| (bar_size > WIL6210_MAX_MEM_SIZE)) { |
| dev_err(&pdev->dev, "Unexpected BAR0 size 0x%x\n", |
| bar_size); |
| return -ENODEV; |
| } |
| |
| wil = wil_if_alloc(dev); |
| if (IS_ERR(wil)) { |
| rc = (int)PTR_ERR(wil); |
| dev_err(dev, "wil_if_alloc failed: %d\n", rc); |
| return rc; |
| } |
| |
| wil->pdev = pdev; |
| pci_set_drvdata(pdev, wil); |
| wil->bar_size = bar_size; |
| /* rollback to if_free */ |
| |
| wil->platform_handle = |
| wil_platform_init(&pdev->dev, &wil->platform_ops, &rops, wil); |
| if (!wil->platform_handle) { |
| rc = -ENODEV; |
| wil_err(wil, "wil_platform_init failed\n"); |
| goto if_free; |
| } |
| /* rollback to err_plat */ |
| |
| /* device supports 48bit addresses */ |
| rc = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(48)); |
| if (rc) { |
| dev_err(dev, "dma_set_mask_and_coherent(48) failed: %d\n", rc); |
| rc = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32)); |
| if (rc) { |
| dev_err(dev, |
| "dma_set_mask_and_coherent(32) failed: %d\n", |
| rc); |
| goto err_plat; |
| } |
| } else { |
| wil->use_extended_dma_addr = 1; |
| } |
| |
| rc = pci_enable_device(pdev); |
| if (rc && pdev->msi_enabled == 0) { |
| wil_err(wil, |
| "pci_enable_device failed, retry with MSI only\n"); |
| /* Work around for platforms that can't allocate IRQ: |
| * retry with MSI only |
| */ |
| pdev->msi_enabled = 1; |
| rc = pci_enable_device(pdev); |
| } |
| if (rc) { |
| wil_err(wil, |
| "pci_enable_device failed, even with MSI only\n"); |
| goto err_plat; |
| } |
| /* rollback to err_disable_pdev */ |
| pci_set_power_state(pdev, PCI_D0); |
| |
| rc = pci_request_region(pdev, 0, WIL_NAME); |
| if (rc) { |
| wil_err(wil, "pci_request_region failed\n"); |
| goto err_disable_pdev; |
| } |
| /* rollback to err_release_reg */ |
| |
| wil->csr = pci_ioremap_bar(pdev, 0); |
| if (!wil->csr) { |
| wil_err(wil, "pci_ioremap_bar failed\n"); |
| rc = -ENODEV; |
| goto err_release_reg; |
| } |
| /* rollback to err_iounmap */ |
| wil_info(wil, "CSR at %pR -> 0x%p\n", &pdev->resource[0], wil->csr); |
| |
| wil_set_capabilities(wil); |
| wil6210_clear_irq(wil); |
| |
| wil->keep_radio_on_during_sleep = |
| wil->platform_ops.keep_radio_on_during_sleep && |
| wil->platform_ops.keep_radio_on_during_sleep( |
| wil->platform_handle) && |
| test_bit(WMI_FW_CAPABILITY_D3_SUSPEND, wil->fw_capabilities); |
| |
| wil_info(wil, "keep_radio_on_during_sleep (%d)\n", |
| wil->keep_radio_on_during_sleep); |
| |
| /* FW should raise IRQ when ready */ |
| rc = wil_if_pcie_enable(wil); |
| if (rc) { |
| wil_err(wil, "Enable device failed\n"); |
| goto err_iounmap; |
| } |
| /* rollback to bus_disable */ |
| |
| rc = wil_if_add(wil); |
| if (rc) { |
| wil_err(wil, "wil_if_add failed: %d\n", rc); |
| goto bus_disable; |
| } |
| |
| #ifdef CONFIG_PM |
| #ifdef CONFIG_PM_SLEEP |
| wil->pm_notify.notifier_call = wil6210_pm_notify; |
| rc = register_pm_notifier(&wil->pm_notify); |
| if (rc) |
| /* Do not fail the driver initialization, as suspend can |
| * be prevented in a later phase if needed |
| */ |
| wil_err(wil, "register_pm_notifier failed: %d\n", rc); |
| #endif /* CONFIG_PM_SLEEP */ |
| #endif /* CONFIG_PM */ |
| |
| wil6210_debugfs_init(wil); |
| |
| |
| return 0; |
| |
| bus_disable: |
| wil_if_pcie_disable(wil); |
| err_iounmap: |
| pci_iounmap(pdev, wil->csr); |
| err_release_reg: |
| pci_release_region(pdev, 0); |
| err_disable_pdev: |
| pci_disable_device(pdev); |
| err_plat: |
| wil_platform_ops_uninit(wil); |
| if_free: |
| wil_if_free(wil); |
| |
| return rc; |
| } |
| |
| static void wil_pcie_remove(struct pci_dev *pdev) |
| { |
| struct wil6210_priv *wil = pci_get_drvdata(pdev); |
| void __iomem *csr = wil->csr; |
| |
| wil_dbg_misc(wil, "pcie_remove\n"); |
| |
| #ifdef CONFIG_PM |
| #ifdef CONFIG_PM_SLEEP |
| unregister_pm_notifier(&wil->pm_notify); |
| #endif /* CONFIG_PM_SLEEP */ |
| #endif /* CONFIG_PM */ |
| |
| wil6210_debugfs_remove(wil); |
| rtnl_lock(); |
| wil_p2p_wdev_free(wil); |
| rtnl_unlock(); |
| wil_if_remove(wil); |
| wil_if_pcie_disable(wil); |
| pci_iounmap(pdev, csr); |
| pci_release_region(pdev, 0); |
| pci_disable_device(pdev); |
| wil_platform_ops_uninit(wil); |
| wil_if_free(wil); |
| } |
| |
| static const struct pci_device_id wil6210_pcie_ids[] = { |
| { PCI_DEVICE(0x1ae9, 0x0310) }, |
| { PCI_DEVICE(0x1ae9, 0x0302) }, /* same as above, firmware broken */ |
| { /* end: all zeroes */ }, |
| }; |
| MODULE_DEVICE_TABLE(pci, wil6210_pcie_ids); |
| |
| #ifdef CONFIG_PM |
| #ifdef CONFIG_PM_SLEEP |
| |
| static int wil6210_suspend(struct device *dev, bool is_runtime) |
| { |
| int rc = 0; |
| struct pci_dev *pdev = to_pci_dev(dev); |
| struct wil6210_priv *wil = pci_get_drvdata(pdev); |
| |
| wil_dbg_pm(wil, "suspend: %s\n", is_runtime ? "runtime" : "system"); |
| |
| rc = wil_can_suspend(wil, is_runtime); |
| if (rc) |
| goto out; |
| |
| rc = wil_suspend(wil, is_runtime); |
| if (!rc) { |
| wil->suspend_stats.successful_suspends++; |
| |
| /* If platform device supports keep_radio_on_during_sleep |
| * it will control PCIe master |
| */ |
| if (!wil->keep_radio_on_during_sleep) |
| /* disable bus mastering */ |
| pci_clear_master(pdev); |
| } |
| out: |
| return rc; |
| } |
| |
| static int wil6210_resume(struct device *dev, bool is_runtime) |
| { |
| int rc = 0; |
| struct pci_dev *pdev = to_pci_dev(dev); |
| struct wil6210_priv *wil = pci_get_drvdata(pdev); |
| |
| wil_dbg_pm(wil, "resume: %s\n", is_runtime ? "runtime" : "system"); |
| |
| /* If platform device supports keep_radio_on_during_sleep it will |
| * control PCIe master |
| */ |
| if (!wil->keep_radio_on_during_sleep) |
| /* allow master */ |
| pci_set_master(pdev); |
| rc = wil_resume(wil, is_runtime); |
| if (rc) { |
| wil_err(wil, "device failed to resume (%d)\n", rc); |
| wil->suspend_stats.failed_resumes++; |
| if (!wil->keep_radio_on_during_sleep) |
| pci_clear_master(pdev); |
| } else { |
| wil->suspend_stats.successful_resumes++; |
| } |
| |
| return rc; |
| } |
| |
| static int wil6210_pm_notify(struct notifier_block *notify_block, |
| unsigned long mode, void *unused) |
| { |
| struct wil6210_priv *wil = container_of( |
| notify_block, struct wil6210_priv, pm_notify); |
| int rc = 0; |
| enum wil_platform_event evt; |
| |
| wil_dbg_pm(wil, "pm_notify: mode (%ld)\n", mode); |
| |
| switch (mode) { |
| case PM_HIBERNATION_PREPARE: |
| case PM_SUSPEND_PREPARE: |
| case PM_RESTORE_PREPARE: |
| rc = wil_can_suspend(wil, false); |
| if (rc) |
| break; |
| evt = WIL_PLATFORM_EVT_PRE_SUSPEND; |
| if (wil->platform_ops.notify) |
| rc = wil->platform_ops.notify(wil->platform_handle, |
| evt); |
| break; |
| case PM_POST_SUSPEND: |
| case PM_POST_HIBERNATION: |
| case PM_POST_RESTORE: |
| evt = WIL_PLATFORM_EVT_POST_SUSPEND; |
| if (wil->platform_ops.notify) |
| rc = wil->platform_ops.notify(wil->platform_handle, |
| evt); |
| break; |
| default: |
| wil_dbg_pm(wil, "unhandled notify mode %ld\n", mode); |
| break; |
| } |
| |
| wil_dbg_pm(wil, "notification mode %ld: rc (%d)\n", mode, rc); |
| return rc; |
| } |
| |
| static int wil6210_pm_suspend(struct device *dev) |
| { |
| return wil6210_suspend(dev, false); |
| } |
| |
| static int wil6210_pm_resume(struct device *dev) |
| { |
| return wil6210_resume(dev, false); |
| } |
| #endif /* CONFIG_PM_SLEEP */ |
| |
| #endif /* CONFIG_PM */ |
| |
| static const struct dev_pm_ops wil6210_pm_ops = { |
| SET_SYSTEM_SLEEP_PM_OPS(wil6210_pm_suspend, wil6210_pm_resume) |
| }; |
| |
| static struct pci_driver wil6210_driver = { |
| .probe = wil_pcie_probe, |
| .remove = wil_pcie_remove, |
| .id_table = wil6210_pcie_ids, |
| .name = WIL_NAME, |
| .driver = { |
| .pm = &wil6210_pm_ops, |
| }, |
| }; |
| |
| static int __init wil6210_driver_init(void) |
| { |
| int rc; |
| |
| rc = wil_platform_modinit(); |
| if (rc) |
| return rc; |
| |
| rc = pci_register_driver(&wil6210_driver); |
| if (rc) |
| wil_platform_modexit(); |
| return rc; |
| } |
| module_init(wil6210_driver_init); |
| |
| static void __exit wil6210_driver_exit(void) |
| { |
| pci_unregister_driver(&wil6210_driver); |
| wil_platform_modexit(); |
| } |
| module_exit(wil6210_driver_exit); |
| |
| MODULE_LICENSE("Dual BSD/GPL"); |
| MODULE_AUTHOR("Qualcomm Atheros <wil6210@qca.qualcomm.com>"); |
| MODULE_DESCRIPTION("Driver for 60g WiFi WIL6210 card"); |