// SPDX-License-Identifier: GPL-2.0-only /* * NXP Wireless LAN device driver: PCIE specific handling * * Copyright 2011-2020 NXP */ #include <linux/iopoll.h> #include <linux/firmware.h> #include "decl.h" #include "ioctl.h" #include "util.h" #include "fw.h" #include "main.h" #include "wmm.h" #include "11n.h" #include "pcie.h" #include "pcie_quirks.h" #define PCIE_VERSION … #define DRV_NAME … static struct mwifiex_if_ops pcie_ops; static const struct mwifiex_pcie_card_reg mwifiex_reg_8766 = …; static const struct mwifiex_pcie_card_reg mwifiex_reg_8897 = …; static const struct mwifiex_pcie_card_reg mwifiex_reg_8997 = …; static struct memory_type_mapping mem_type_mapping_tbl_w8897[] = …; static struct memory_type_mapping mem_type_mapping_tbl_w8997[] = …; static const struct mwifiex_pcie_device mwifiex_pcie8766 = …; static const struct mwifiex_pcie_device mwifiex_pcie8897 = …; static const struct mwifiex_pcie_device mwifiex_pcie8997 = …; static const struct of_device_id mwifiex_pcie_of_match_table[] __maybe_unused = …; static int mwifiex_pcie_probe_of(struct device *dev) { … } static void mwifiex_pcie_work(struct work_struct *work); static int mwifiex_pcie_delete_rxbd_ring(struct mwifiex_adapter *adapter); static int mwifiex_pcie_delete_evtbd_ring(struct mwifiex_adapter *adapter); static int mwifiex_map_pci_memory(struct mwifiex_adapter *adapter, struct sk_buff *skb, size_t size, int flags) { … } static void mwifiex_unmap_pci_memory(struct mwifiex_adapter *adapter, struct sk_buff *skb, int flags) { … } /* * This function writes data into PCIE card register. */ static inline void mwifiex_write_reg(struct mwifiex_adapter *adapter, int reg, u32 data) { … } /* Non-void wrapper needed for read_poll_timeout(). */ static inline int mwifiex_write_reg_rpt(struct mwifiex_adapter *adapter, int reg, u32 data) { … } /* This function reads data from PCIE card register. */ static int mwifiex_read_reg(struct mwifiex_adapter *adapter, int reg, u32 *data) { … } /* This function reads u8 data from PCIE card register. */ static int mwifiex_read_reg_byte(struct mwifiex_adapter *adapter, int reg, u8 *data) { … } /* * This function reads sleep cookie and checks if FW is ready */ static bool mwifiex_pcie_ok_to_access_hw(struct mwifiex_adapter *adapter) { … } #ifdef CONFIG_PM_SLEEP /* * Kernel needs to suspend all functions separately. Therefore all * registered functions must have drivers with suspend and resume * methods. Failing that the kernel simply removes the whole card. * * If already not suspended, this function allocates and sends a host * sleep activate request to the firmware and turns off the traffic. */ static int mwifiex_pcie_suspend(struct device *dev) { … } /* * Kernel needs to suspend all functions separately. Therefore all * registered functions must have drivers with suspend and resume * methods. Failing that the kernel simply removes the whole card. * * If already not resumed, this function turns on the traffic and * sends a host sleep cancel request to the firmware. */ static int mwifiex_pcie_resume(struct device *dev) { … } #endif /* * This function probes an mwifiex device and registers it. It allocates * the card structure, enables PCIE function number and initiates the * device registration and initialization procedure by adding a logical * interface. */ static int mwifiex_pcie_probe(struct pci_dev *pdev, const struct pci_device_id *ent) { … } /* * This function removes the interface and frees up the card structure. */ static void mwifiex_pcie_remove(struct pci_dev *pdev) { … } static void mwifiex_pcie_shutdown(struct pci_dev *pdev) { … } static void mwifiex_pcie_coredump(struct device *dev) { … } static const struct pci_device_id mwifiex_ids[] = …; MODULE_DEVICE_TABLE(pci, mwifiex_ids); /* * Cleanup all software without cleaning anything related to PCIe and HW. */ static void mwifiex_pcie_reset_prepare(struct pci_dev *pdev) { … } /* * Kernel stores and restores PCIe function context before and after performing * FLR respectively. Reconfigure the software and firmware including firmware * redownload. */ static void mwifiex_pcie_reset_done(struct pci_dev *pdev) { … } static const struct pci_error_handlers mwifiex_pcie_err_handler = …; #ifdef CONFIG_PM_SLEEP /* Power Management Hooks */ static SIMPLE_DEV_PM_OPS(mwifiex_pcie_pm_ops, mwifiex_pcie_suspend, mwifiex_pcie_resume); #endif /* PCI Device Driver */ static struct pci_driver mwifiex_pcie = …; /* * This function adds delay loop to ensure FW is awake before proceeding. */ static void mwifiex_pcie_dev_wakeup_delay(struct mwifiex_adapter *adapter) { … } static void mwifiex_delay_for_sleep_cookie(struct mwifiex_adapter *adapter, u32 max_delay_loop_cnt) { … } #define N_WAKEUP_TRIES_SHORT_INTERVAL … #define N_WAKEUP_TRIES_LONG_INTERVAL … /* This function wakes up the card by reading fw_status register. */ static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter) { … } /* * This function is called after the card has woken up. * * The card configuration register is reset. */ static int mwifiex_pm_wakeup_card_complete(struct mwifiex_adapter *adapter) { … } /* * This function disables the host interrupt. * * The host interrupt mask is read, the disable bit is reset and * written back to the card host interrupt mask register. */ static void mwifiex_pcie_disable_host_int(struct mwifiex_adapter *adapter) { … } /* * This function enables the host interrupt. * * The host interrupt enable mask is written to the card * host interrupt mask register. */ static int mwifiex_pcie_enable_host_int(struct mwifiex_adapter *adapter) { … } /* * This function initializes TX buffer ring descriptors */ static int mwifiex_init_txq_ring(struct mwifiex_adapter *adapter) { … } /* This function initializes RX buffer ring descriptors. Each SKB is allocated * here and after mapping PCI memory, its physical address is assigned to * PCIE Rx buffer descriptor's physical address. */ static int mwifiex_init_rxq_ring(struct mwifiex_adapter *adapter) { … } /* This function initializes event buffer ring descriptors. Each SKB is * allocated here and after mapping PCI memory, its physical address is assigned * to PCIE Rx buffer descriptor's physical address */ static int mwifiex_pcie_init_evt_ring(struct mwifiex_adapter *adapter) { … } /* This function cleans up TX buffer rings. If any of the buffer list has valid * SKB address, associated SKB is freed. */ static void mwifiex_cleanup_txq_ring(struct mwifiex_adapter *adapter) { … } /* This function cleans up RX buffer rings. If any of the buffer list has valid * SKB address, associated SKB is freed. */ static void mwifiex_cleanup_rxq_ring(struct mwifiex_adapter *adapter) { … } /* This function cleans up event buffer rings. If any of the buffer list has * valid SKB address, associated SKB is freed. */ static void mwifiex_cleanup_evt_ring(struct mwifiex_adapter *adapter) { … } /* This function creates buffer descriptor ring for TX */ static int mwifiex_pcie_create_txbd_ring(struct mwifiex_adapter *adapter) { … } static int mwifiex_pcie_delete_txbd_ring(struct mwifiex_adapter *adapter) { … } /* * This function creates buffer descriptor ring for RX */ static int mwifiex_pcie_create_rxbd_ring(struct mwifiex_adapter *adapter) { … } /* * This function deletes Buffer descriptor ring for RX */ static int mwifiex_pcie_delete_rxbd_ring(struct mwifiex_adapter *adapter) { … } /* * This function creates buffer descriptor ring for Events */ static int mwifiex_pcie_create_evtbd_ring(struct mwifiex_adapter *adapter) { … } /* * This function deletes Buffer descriptor ring for Events */ static int mwifiex_pcie_delete_evtbd_ring(struct mwifiex_adapter *adapter) { … } /* * This function allocates a buffer for CMDRSP */ static int mwifiex_pcie_alloc_cmdrsp_buf(struct mwifiex_adapter *adapter) { … } /* * This function deletes a buffer for CMDRSP */ static int mwifiex_pcie_delete_cmdrsp_buf(struct mwifiex_adapter *adapter) { … } /* * This function allocates a buffer for sleep cookie */ static int mwifiex_pcie_alloc_sleep_cookie_buf(struct mwifiex_adapter *adapter) { … } /* * This function deletes buffer for sleep cookie */ static int mwifiex_pcie_delete_sleep_cookie_buf(struct mwifiex_adapter *adapter) { … } /* This function flushes the TX buffer descriptor ring * This function defined as handler is also called while cleaning TXRX * during disconnect/ bss stop. */ static void mwifiex_clean_pcie_ring_buf(struct mwifiex_adapter *adapter) { … } /* * This function unmaps and frees downloaded data buffer */ static int mwifiex_pcie_send_data_complete(struct mwifiex_adapter *adapter) { … } /* This function sends data buffer to device. First 4 bytes of payload * are filled with payload length and payload type. Then this payload * is mapped to PCI device memory. Tx ring pointers are advanced accordingly. * Download ready interrupt to FW is deffered if Tx ring is not full and * additional payload can be accomodated. * Caller must ensure tx_param parameter to this function is not NULL. */ static int mwifiex_pcie_send_data(struct mwifiex_adapter *adapter, struct sk_buff *skb, struct mwifiex_tx_param *tx_param) { … } /* * This function handles received buffer ring and * dispatches packets to upper */ static int mwifiex_pcie_process_recv_data(struct mwifiex_adapter *adapter) { … } /* * This function downloads the boot command to device */ static int mwifiex_pcie_send_boot_cmd(struct mwifiex_adapter *adapter, struct sk_buff *skb) { … } /* This function init rx port in firmware which in turn enables to receive data * from device before transmitting any packet. */ static void mwifiex_pcie_init_fw_port(struct mwifiex_adapter *adapter) { … } /* This function downloads commands to the device */ static int mwifiex_pcie_send_cmd(struct mwifiex_adapter *adapter, struct sk_buff *skb) { … } /* * This function handles command complete interrupt */ static int mwifiex_pcie_process_cmd_complete(struct mwifiex_adapter *adapter) { … } /* * Command Response processing complete handler */ static int mwifiex_pcie_cmdrsp_complete(struct mwifiex_adapter *adapter, struct sk_buff *skb) { … } /* * This function handles firmware event ready interrupt */ static int mwifiex_pcie_process_event_ready(struct mwifiex_adapter *adapter) { … } /* * Event processing complete handler */ static int mwifiex_pcie_event_complete(struct mwifiex_adapter *adapter, struct sk_buff *skb) { … } /* Combo firmware image is a combination of * (1) combo crc heaer, start with CMD5 * (2) bluetooth image, start with CMD7, end with CMD6, data wrapped in CMD1. * (3) wifi image. * * This function bypass the header and bluetooth part, return * the offset of tail wifi-only part. If the image is already wifi-only, * that is start with CMD1, return 0. */ static int mwifiex_extract_wifi_fw(struct mwifiex_adapter *adapter, const void *firmware, u32 firmware_len) { … } /* * This function downloads the firmware to the card. * * Firmware is downloaded to the card in blocks. Every block download * is tested for CRC errors, and retried a number of times before * returning failure. */ static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter, struct mwifiex_fw_image *fw) { … } /* * This function checks the firmware status in card. */ static int mwifiex_check_fw_status(struct mwifiex_adapter *adapter, u32 poll_num) { … } /* This function checks if WLAN is the winner. */ static int mwifiex_check_winner_status(struct mwifiex_adapter *adapter) { … } /* * This function reads the interrupt status from card. */ static void mwifiex_interrupt_status(struct mwifiex_adapter *adapter, int msg_id) { … } /* * Interrupt handler for PCIe root port * * This function reads the interrupt status from firmware and assigns * the main process in workqueue which will handle the interrupt. */ static irqreturn_t mwifiex_pcie_interrupt(int irq, void *context) { … } /* * This function checks the current interrupt status. * * The following interrupts are checked and handled by this function - * - Data sent * - Command sent * - Command received * - Packets received * - Events received * * In case of Rx packets received, the packets are uploaded from card to * host and processed accordingly. */ static int mwifiex_process_int_status(struct mwifiex_adapter *adapter) { … } /* * This function downloads data from driver to card. * * Both commands and data packets are transferred to the card by this * function. * * This function adds the PCIE specific header to the front of the buffer * before transferring. The header contains the length of the packet and * the type. The firmware handles the packets based upon this set type. */ static int mwifiex_pcie_host_to_card(struct mwifiex_adapter *adapter, u8 type, struct sk_buff *skb, struct mwifiex_tx_param *tx_param) { … } /* Function to dump PCIE scratch registers in case of FW crash */ static int mwifiex_pcie_reg_dump(struct mwifiex_adapter *adapter, char *drv_buf) { … } /* This function read/write firmware */ static enum rdwr_status mwifiex_pcie_rdwr_firmware(struct mwifiex_adapter *adapter, u8 doneflag) { … } /* This function dump firmware memory to file */ static void mwifiex_pcie_fw_dump(struct mwifiex_adapter *adapter) { … } static void mwifiex_pcie_device_dump_work(struct mwifiex_adapter *adapter) { … } static void mwifiex_pcie_card_reset_work(struct mwifiex_adapter *adapter) { … } static void mwifiex_pcie_work(struct work_struct *work) { … } /* This function dumps FW information */ static void mwifiex_pcie_device_dump(struct mwifiex_adapter *adapter) { … } static void mwifiex_pcie_card_reset(struct mwifiex_adapter *adapter) { … } static int mwifiex_pcie_alloc_buffers(struct mwifiex_adapter *adapter) { … } static void mwifiex_pcie_free_buffers(struct mwifiex_adapter *adapter) { … } /* * This function initializes the PCI-E host memory space, WCB rings, etc. */ static int mwifiex_init_pcie(struct mwifiex_adapter *adapter) { … } /* * This function cleans up the allocated card buffers. */ static void mwifiex_cleanup_pcie(struct mwifiex_adapter *adapter) { … } static int mwifiex_pcie_request_irq(struct mwifiex_adapter *adapter) { … } /* * This function gets the firmware name for downloading by revision id * * Read revision id register to get revision id */ static void mwifiex_pcie_get_fw_name(struct mwifiex_adapter *adapter) { … } /* * This function registers the PCIE device. * * PCIE IRQ is claimed, block size is set and driver data is initialized. */ static int mwifiex_register_dev(struct mwifiex_adapter *adapter) { … } /* * This function unregisters the PCIE device. * * The PCIE IRQ is released, the function is disabled and driver * data is set to null. */ static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter) { … } /* * This function initializes the PCI-E host memory space, WCB rings, etc., * similar to mwifiex_init_pcie(), but without resetting PCI-E state. */ static void mwifiex_pcie_up_dev(struct mwifiex_adapter *adapter) { … } /* This function cleans up the PCI-E host memory space. */ static void mwifiex_pcie_down_dev(struct mwifiex_adapter *adapter) { … } static struct mwifiex_if_ops pcie_ops = …; module_pci_driver(…) …; MODULE_AUTHOR(…) …; MODULE_DESCRIPTION(…) …; MODULE_VERSION(…); MODULE_LICENSE(…) …; MODULE_FIRMWARE(…); MODULE_FIRMWARE(…); MODULE_FIRMWARE(…); MODULE_FIRMWARE(…); MODULE_FIRMWARE(…); MODULE_FIRMWARE(…);
Codebase Browser
linux