include/net/cnss2.h

   1 /* Copyright (c) 2016-2019, The Linux Foundation. All rights reserved.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License version 2 and
   5  * only version 2 as published by the Free Software Foundation.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  */
  12
  13 #ifndef _NET_CNSS2_H
  14 #define _NET_CNSS2_H
  15
  16 #include <linux/pci.h>
  17 #include <linux/usb.h>
  18
  19 #define CNSS_MAX_FILE_NAME              20
  20 #define CNSS_MAX_TIMESTAMP_LEN          32
  21
  22 /*
  23  * Temporary change for compilation, will be removed
  24  * after WLAN host driver switched to use new APIs
  25  */
  26 #define CNSS_API_WITH_DEV
  27
  28 enum cnss_bus_width_type {
  29         CNSS_BUS_WIDTH_NONE,
  30         CNSS_BUS_WIDTH_LOW,
  31         CNSS_BUS_WIDTH_MEDIUM,
  32         CNSS_BUS_WIDTH_HIGH
  33 };
  34
  35 enum cnss_platform_cap_flag {
  36         CNSS_HAS_EXTERNAL_SWREG = 0x01,
  37         CNSS_HAS_UART_ACCESS = 0x02,
  38 };
  39
  40 struct cnss_platform_cap {
  41         u32 cap_flag;
  42 };
  43
  44 struct cnss_fw_files {
  45         char image_file[CNSS_MAX_FILE_NAME];
  46         char board_data[CNSS_MAX_FILE_NAME];
  47         char otp_data[CNSS_MAX_FILE_NAME];
  48         char utf_file[CNSS_MAX_FILE_NAME];
  49         char utf_board_data[CNSS_MAX_FILE_NAME];
  50         char epping_file[CNSS_MAX_FILE_NAME];
  51         char evicted_data[CNSS_MAX_FILE_NAME];
  52 };
  53
  54 struct cnss_soc_info {
  55         void __iomem *va;
  56         phys_addr_t pa;
  57         uint32_t chip_id;
  58         uint32_t chip_family;
  59         uint32_t board_id;
  60         uint32_t soc_id;
  61         uint32_t fw_version;
  62         char fw_build_timestamp[CNSS_MAX_TIMESTAMP_LEN + 1];
  63 };
  64
  65 struct cnss_wlan_runtime_ops {
  66         int (*runtime_suspend)(struct pci_dev *pdev);
  67         int (*runtime_resume)(struct pci_dev *pdev);
  68 };
  69
  70 struct cnss_wlan_driver {
  71         char *name;
  72         int  (*probe)(struct pci_dev *pdev, const struct pci_device_id *id);
  73         void (*remove)(struct pci_dev *pdev);
  74         int  (*reinit)(struct pci_dev *pdev, const struct pci_device_id *id);
  75         void (*shutdown)(struct pci_dev *pdev);
  76         void (*crash_shutdown)(struct pci_dev *pdev);
  77         int  (*suspend)(struct pci_dev *pdev, pm_message_t state);
  78         int  (*resume)(struct pci_dev *pdev);
  79         int  (*suspend_noirq)(struct pci_dev *pdev);
  80         int  (*resume_noirq)(struct pci_dev *pdev);
  81         void (*modem_status)(struct pci_dev *, int state);
  82         void (*update_status)(struct pci_dev *pdev, uint32_t status);
  83         struct cnss_wlan_runtime_ops *runtime_ops;
  84         const struct pci_device_id *id_table;
  85 };
  86
  87 struct cnss_usb_wlan_driver {
  88         char *name;
  89         int  (*probe)(struct usb_interface *pintf, const struct usb_device_id
  90                       *id);
  91         void (*remove)(struct usb_interface *pintf);
  92         int  (*reinit)(struct usb_interface *pintf, const struct usb_device_id
  93                        *id);
  94         void (*shutdown)(struct usb_interface *pintf);
  95         void (*crash_shutdown)(struct usb_interface *pintf);
  96         int  (*suspend)(struct usb_interface *pintf, pm_message_t state);
  97         int  (*resume)(struct usb_interface *pintf);
  98         int  (*reset_resume)(struct usb_interface *pintf);
  99         void (*update_status)(struct usb_interface *pintf, uint32_t status);
 100         const struct usb_device_id *id_table;
 101 };
 102
 103 enum cnss_driver_status {
 104         CNSS_UNINITIALIZED,
 105         CNSS_INITIALIZED,
 106         CNSS_LOAD_UNLOAD,
 107         CNSS_RECOVERY,
 108         CNSS_FW_DOWN,
 109 };
 110
 111 struct cnss_ce_tgt_pipe_cfg {
 112         u32 pipe_num;
 113         u32 pipe_dir;
 114         u32 nentries;
 115         u32 nbytes_max;
 116         u32 flags;
 117         u32 reserved;
 118 };
 119
 120 struct cnss_ce_svc_pipe_cfg {
 121         u32 service_id;
 122         u32 pipe_dir;
 123         u32 pipe_num;
 124 };
 125
 126 struct cnss_shadow_reg_cfg {
 127         u16 ce_id;
 128         u16 reg_offset;
 129 };
 130
 131 struct cnss_shadow_reg_v2_cfg {
 132         u32 addr;
 133 };
 134
 135 struct cnss_rri_over_ddr_cfg {
 136         u32 base_addr_low;
 137         u32 base_addr_high;
 138 };
 139
 140 struct cnss_wlan_enable_cfg {
 141         u32 num_ce_tgt_cfg;
 142         struct cnss_ce_tgt_pipe_cfg *ce_tgt_cfg;
 143         u32 num_ce_svc_pipe_cfg;
 144         struct cnss_ce_svc_pipe_cfg *ce_svc_cfg;
 145         u32 num_shadow_reg_cfg;
 146         struct cnss_shadow_reg_cfg *shadow_reg_cfg;
 147         u32 num_shadow_reg_v2_cfg;
 148         struct cnss_shadow_reg_v2_cfg *shadow_reg_v2_cfg;
 149         bool rri_over_ddr_cfg_valid;
 150         struct cnss_rri_over_ddr_cfg rri_over_ddr_cfg;
 151 };
 152
 153 enum cnss_driver_mode {
 154         CNSS_MISSION,
 155         CNSS_FTM,
 156         CNSS_EPPING,
 157         CNSS_WALTEST,
 158         CNSS_OFF,
 159         CNSS_CCPM,
 160         CNSS_QVIT,
 161         CNSS_CALIBRATION,
 162 };
 163
 164 enum cnss_recovery_reason {
 165         CNSS_REASON_DEFAULT,
 166         CNSS_REASON_LINK_DOWN,
 167         CNSS_REASON_RDDM,
 168         CNSS_REASON_TIMEOUT,
 169 };
 170
 171 extern int cnss_wlan_register_driver(struct cnss_wlan_driver *driver);
 172 extern void cnss_wlan_unregister_driver(struct cnss_wlan_driver *driver);
 173 extern void cnss_device_crashed(struct device *dev);
 174 #ifdef CONFIG_PCI_MSM
 175 extern int cnss_pci_link_down(struct device *dev);
 176 extern int cnss_wlan_pm_control(struct device *dev, bool vote);
 177 #else /* CONFIG_PCI_MSM */
 178 static inline int cnss_pci_link_down(struct device *dev)
 179 {
 180         return 0;
 181 }
 182 static inline int cnss_wlan_pm_control(struct device *dev, bool vote)
 183 {
 184         return 0;
 185 }
 186 #endif /* CONFIG_PCI_MSM */
 187 extern int cnss_pci_is_device_down(struct device *dev);
 188 extern void cnss_schedule_recovery(struct device *dev,
 189                                    enum cnss_recovery_reason reason);
 190 extern int cnss_self_recovery(struct device *dev,
 191                               enum cnss_recovery_reason reason);
 192 extern int cnss_force_fw_assert(struct device *dev);
 193 extern int cnss_force_collect_rddm(struct device *dev);
 194 extern void *cnss_get_virt_ramdump_mem(struct device *dev, unsigned long *size);
 195 extern int cnss_get_fw_files_for_target(struct device *dev,
 196                                         struct cnss_fw_files *pfw_files,
 197                                         u32 target_type, u32 target_version);
 198 extern int cnss_get_platform_cap(struct device *dev,
 199                                  struct cnss_platform_cap *cap);
 200 extern struct dma_iommu_mapping *cnss_smmu_get_mapping(struct device *dev);
 201 extern int cnss_smmu_map(struct device *dev,
 202                          phys_addr_t paddr, uint32_t *iova_addr, size_t size);
 203 extern int cnss_get_soc_info(struct device *dev, struct cnss_soc_info *info);
 204 extern int cnss_request_bus_bandwidth(struct device *dev, int bandwidth);
 205 extern int cnss_power_up(struct device *dev);
 206 extern int cnss_power_down(struct device *dev);
 207 extern void cnss_request_pm_qos(struct device *dev, u32 qos_val);
 208 extern void cnss_remove_pm_qos(struct device *dev);
 209 extern void cnss_lock_pm_sem(struct device *dev);
 210 extern void cnss_release_pm_sem(struct device *dev);
 211 extern int cnss_auto_suspend(struct device *dev);
 212 extern int cnss_auto_resume(struct device *dev);
 213 extern int cnss_pci_force_wake_request(struct device *dev);
 214 extern int cnss_pci_is_device_awake(struct device *dev);
 215 extern int cnss_pci_force_wake_release(struct device *dev);
 216 extern int cnss_get_user_msi_assignment(struct device *dev, char *user_name,
 217                                         int *num_vectors,
 218                                         uint32_t *user_base_data,
 219                                         uint32_t *base_vector);
 220 extern int cnss_get_msi_irq(struct device *dev, unsigned int vector);
 221 extern void cnss_get_msi_address(struct device *dev, uint32_t *msi_addr_low,
 222                                  uint32_t *msi_addr_high);
 223 extern int cnss_wlan_enable(struct device *dev,
 224                             struct cnss_wlan_enable_cfg *config,
 225                             enum cnss_driver_mode mode,
 226                             const char *host_version);
 227 extern int cnss_wlan_disable(struct device *dev, enum cnss_driver_mode mode);
 228 extern unsigned int cnss_get_qmi_timeout(void);
 229 extern int cnss_athdiag_read(struct device *dev, uint32_t offset,
 230                              uint32_t mem_type, uint32_t data_len,
 231                              uint8_t *output);
 232 extern int cnss_athdiag_write(struct device *dev, uint32_t offset,
 233                               uint32_t mem_type, uint32_t data_len,
 234                               uint8_t *input);
 235 extern int cnss_set_fw_log_mode(struct device *dev, uint8_t fw_log_mode);
 236 extern int cnss_usb_wlan_register_driver(struct cnss_usb_wlan_driver *driver);
 237 extern void cnss_usb_wlan_unregister_driver(struct cnss_usb_wlan_driver *
 238                                             driver);
 239 extern int cnss_usb_is_device_down(struct device *dev);
 240
 241 #endif /* _NET_CNSS2_H */