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 #include <linux/mmc/sdio_func.h>
  19 #ifdef CONFIG_SDIO_QCN
  20 #include <linux/qcn_sdio_al.h>
  21 #endif
  22
  23 #define CNSS_MAX_FILE_NAME              20
  24 #define CNSS_MAX_TIMESTAMP_LEN          32
  25
  26 /*
  27  * Temporary change for compilation, will be removed
  28  * after WLAN host driver switched to use new APIs
  29  */
  30 #define CNSS_API_WITH_DEV
  31
  32 enum cnss_bus_width_type {
  33         CNSS_BUS_WIDTH_NONE,
  34         CNSS_BUS_WIDTH_LOW,
  35         CNSS_BUS_WIDTH_MEDIUM,
  36         CNSS_BUS_WIDTH_HIGH
  37 };
  38
  39 enum cnss_platform_cap_flag {
  40         CNSS_HAS_EXTERNAL_SWREG = 0x01,
  41         CNSS_HAS_UART_ACCESS = 0x02,
  42 };
  43
  44 struct cnss_platform_cap {
  45         u32 cap_flag;
  46 };
  47
  48 struct cnss_fw_files {
  49         char image_file[CNSS_MAX_FILE_NAME];
  50         char board_data[CNSS_MAX_FILE_NAME];
  51         char otp_data[CNSS_MAX_FILE_NAME];
  52         char utf_file[CNSS_MAX_FILE_NAME];
  53         char utf_board_data[CNSS_MAX_FILE_NAME];
  54         char epping_file[CNSS_MAX_FILE_NAME];
  55         char evicted_data[CNSS_MAX_FILE_NAME];
  56 };
  57
  58 struct cnss_device_version {
  59         u32 family_number;
  60         u32 device_number;
  61         u32 major_version;
  62         u32 minor_version;
  63 };
  64
  65 struct cnss_soc_info {
  66         void __iomem *va;
  67         phys_addr_t pa;
  68         uint32_t chip_id;
  69         uint32_t chip_family;
  70         uint32_t board_id;
  71         uint32_t soc_id;
  72         uint32_t fw_version;
  73         char fw_build_timestamp[CNSS_MAX_TIMESTAMP_LEN + 1];
  74         struct cnss_device_version device_version;
  75 };
  76
  77 struct cnss_wlan_runtime_ops {
  78         int (*runtime_suspend)(struct pci_dev *pdev);
  79         int (*runtime_resume)(struct pci_dev *pdev);
  80 };
  81
  82 struct cnss_wlan_driver {
  83         char *name;
  84         int  (*probe)(struct pci_dev *pdev, const struct pci_device_id *id);
  85         void (*remove)(struct pci_dev *pdev);
  86         int (*idle_restart)(struct pci_dev *pdev,
  87                             const struct pci_device_id *id);
  88         int  (*idle_shutdown)(struct pci_dev *pdev);
  89         int  (*reinit)(struct pci_dev *pdev, const struct pci_device_id *id);
  90         void (*shutdown)(struct pci_dev *pdev);
  91         void (*crash_shutdown)(struct pci_dev *pdev);
  92         int  (*suspend)(struct pci_dev *pdev, pm_message_t state);
  93         int  (*resume)(struct pci_dev *pdev);
  94         int  (*suspend_noirq)(struct pci_dev *pdev);
  95         int  (*resume_noirq)(struct pci_dev *pdev);
  96         void (*modem_status)(struct pci_dev *, int state);
  97         void (*update_status)(struct pci_dev *pdev, uint32_t status);
  98         struct cnss_wlan_runtime_ops *runtime_ops;
  99         const struct pci_device_id *id_table;
 100 };
 101
 102 struct cnss_usb_wlan_driver {
 103         char *name;
 104         int  (*probe)(struct usb_interface *pintf, const struct usb_device_id
 105                       *id);
 106         void (*remove)(struct usb_interface *pintf);
 107         int  (*reinit)(struct usb_interface *pintf, const struct usb_device_id
 108                        *id);
 109         void (*shutdown)(struct usb_interface *pintf);
 110         void (*crash_shutdown)(struct usb_interface *pintf);
 111         int  (*suspend)(struct usb_interface *pintf, pm_message_t state);
 112         int  (*resume)(struct usb_interface *pintf);
 113         int  (*reset_resume)(struct usb_interface *pintf);
 114         void (*update_status)(struct usb_interface *pintf, uint32_t status);
 115         const struct usb_device_id *id_table;
 116 };
 117
 118 #ifdef CONFIG_SDIO_QCN
 119 struct cnss_sdio_wlan_driver {
 120         const char *name;
 121         const struct sdio_device_id *id_table;
 122         int (*probe)(struct sdio_func *, const struct sdio_device_id *);
 123         void (*remove)(struct sdio_func *);
 124         int (*reinit)(struct sdio_func *, const struct sdio_device_id *);
 125         void (*shutdown)(struct sdio_func *);
 126         void (*crash_shutdown)(struct sdio_func *);
 127         int (*suspend)(struct device *);
 128         int (*resume)(struct device *);
 129         void (*update_status)(struct sdio_func *, uint32_t status);
 130 };
 131 #endif
 132
 133 enum cnss_driver_status {
 134         CNSS_UNINITIALIZED,
 135         CNSS_INITIALIZED,
 136         CNSS_LOAD_UNLOAD,
 137         CNSS_RECOVERY,
 138         CNSS_FW_DOWN,
 139 };
 140
 141 struct cnss_ce_tgt_pipe_cfg {
 142         u32 pipe_num;
 143         u32 pipe_dir;
 144         u32 nentries;
 145         u32 nbytes_max;
 146         u32 flags;
 147         u32 reserved;
 148 };
 149
 150 struct cnss_ce_svc_pipe_cfg {
 151         u32 service_id;
 152         u32 pipe_dir;
 153         u32 pipe_num;
 154 };
 155
 156 struct cnss_shadow_reg_cfg {
 157         u16 ce_id;
 158         u16 reg_offset;
 159 };
 160
 161 struct cnss_shadow_reg_v2_cfg {
 162         u32 addr;
 163 };
 164
 165 struct cnss_rri_over_ddr_cfg {
 166         u32 base_addr_low;
 167         u32 base_addr_high;
 168 };
 169
 170 struct cnss_wlan_enable_cfg {
 171         u32 num_ce_tgt_cfg;
 172         struct cnss_ce_tgt_pipe_cfg *ce_tgt_cfg;
 173         u32 num_ce_svc_pipe_cfg;
 174         struct cnss_ce_svc_pipe_cfg *ce_svc_cfg;
 175         u32 num_shadow_reg_cfg;
 176         struct cnss_shadow_reg_cfg *shadow_reg_cfg;
 177         u32 num_shadow_reg_v2_cfg;
 178         struct cnss_shadow_reg_v2_cfg *shadow_reg_v2_cfg;
 179         bool rri_over_ddr_cfg_valid;
 180         struct cnss_rri_over_ddr_cfg rri_over_ddr_cfg;
 181 };
 182
 183 enum cnss_driver_mode {
 184         CNSS_MISSION,
 185         CNSS_FTM,
 186         CNSS_EPPING,
 187         CNSS_WALTEST,
 188         CNSS_OFF,
 189         CNSS_CCPM,
 190         CNSS_QVIT,
 191         CNSS_CALIBRATION,
 192 };
 193
 194 enum cnss_recovery_reason {
 195         CNSS_REASON_DEFAULT,
 196         CNSS_REASON_LINK_DOWN,
 197         CNSS_REASON_RDDM,
 198         CNSS_REASON_TIMEOUT,
 199 };
 200
 201 extern int cnss_wlan_register_driver(struct cnss_wlan_driver *driver);
 202 extern void cnss_wlan_unregister_driver(struct cnss_wlan_driver *driver);
 203 extern void cnss_device_crashed(struct device *dev);
 204 #ifdef CONFIG_PCI_MSM
 205 extern int cnss_pci_link_down(struct device *dev);
 206 extern int cnss_wlan_pm_control(struct device *dev, bool vote);
 207 #else /* CONFIG_PCI_MSM */
 208 static inline int cnss_pci_link_down(struct device *dev)
 209 {
 210         return 0;
 211 }
 212 static inline int cnss_wlan_pm_control(struct device *dev, bool vote)
 213 {
 214         return 0;
 215 }
 216 #endif /* CONFIG_PCI_MSM */
 217 extern int cnss_pci_is_device_down(struct device *dev);
 218 extern void cnss_schedule_recovery(struct device *dev,
 219                                    enum cnss_recovery_reason reason);
 220 extern int cnss_self_recovery(struct device *dev,
 221                               enum cnss_recovery_reason reason);
 222 extern int cnss_force_fw_assert(struct device *dev);
 223 extern int cnss_force_collect_rddm(struct device *dev);
 224 extern void *cnss_get_virt_ramdump_mem(struct device *dev, unsigned long *size);
 225 extern int cnss_get_fw_files_for_target(struct device *dev,
 226                                         struct cnss_fw_files *pfw_files,
 227                                         u32 target_type, u32 target_version);
 228 extern int cnss_get_platform_cap(struct device *dev,
 229                                  struct cnss_platform_cap *cap);
 230 extern struct dma_iommu_mapping *cnss_smmu_get_mapping(struct device *dev);
 231 extern int cnss_smmu_map(struct device *dev,
 232                          phys_addr_t paddr, uint32_t *iova_addr, size_t size);
 233 extern int cnss_get_soc_info(struct device *dev, struct cnss_soc_info *info);
 234 extern int cnss_request_bus_bandwidth(struct device *dev, int bandwidth);
 235 extern int cnss_power_up(struct device *dev);
 236 extern int cnss_power_down(struct device *dev);
 237 extern int cnss_idle_restart(struct device *dev);
 238 extern int cnss_idle_shutdown(struct device *dev);
 239 extern void cnss_request_pm_qos(struct device *dev, u32 qos_val);
 240 extern void cnss_remove_pm_qos(struct device *dev);
 241 extern void cnss_lock_pm_sem(struct device *dev);
 242 extern void cnss_release_pm_sem(struct device *dev);
 243 extern int cnss_auto_suspend(struct device *dev);
 244 extern int cnss_auto_resume(struct device *dev);
 245 extern int cnss_pci_is_drv_connected(struct device *dev);
 246 extern int cnss_pci_force_wake_request(struct device *dev);
 247 extern int cnss_pci_is_device_awake(struct device *dev);
 248 extern int cnss_pci_force_wake_release(struct device *dev);
 249 extern int cnss_get_user_msi_assignment(struct device *dev, char *user_name,
 250                                         int *num_vectors,
 251                                         uint32_t *user_base_data,
 252                                         uint32_t *base_vector);
 253 extern int cnss_get_msi_irq(struct device *dev, unsigned int vector);
 254 extern void cnss_get_msi_address(struct device *dev, uint32_t *msi_addr_low,
 255                                  uint32_t *msi_addr_high);
 256 extern int cnss_wlan_enable(struct device *dev,
 257                             struct cnss_wlan_enable_cfg *config,
 258                             enum cnss_driver_mode mode,
 259                             const char *host_version);
 260 extern int cnss_wlan_disable(struct device *dev, enum cnss_driver_mode mode);
 261 extern unsigned int cnss_get_qmi_timeout(void);
 262 extern int cnss_athdiag_read(struct device *dev, uint32_t offset,
 263                              uint32_t mem_type, uint32_t data_len,
 264                              uint8_t *output);
 265 extern int cnss_athdiag_write(struct device *dev, uint32_t offset,
 266                               uint32_t mem_type, uint32_t data_len,
 267                               uint8_t *input);
 268 extern int cnss_set_fw_log_mode(struct device *dev, uint8_t fw_log_mode);
 269 extern int cnss_usb_wlan_register_driver(struct cnss_usb_wlan_driver *driver);
 270 extern void cnss_usb_wlan_unregister_driver(struct cnss_usb_wlan_driver *
 271                                             driver);
 272 extern int cnss_usb_is_device_down(struct device *dev);
 273 #ifdef CONFIG_SDIO_QCN
 274 extern int cnss_sdio_wlan_register_driver(struct cnss_sdio_wlan_driver *
 275                                           driver_ops);
 276 extern void cnss_sdio_wlan_unregister_driver(struct cnss_sdio_wlan_driver *
 277                                              driver_ops);
 278 extern struct sdio_al_client_handle *cnss_sdio_wlan_get_sdio_al_client_handle(
 279                                                        struct sdio_func *func);
 280 extern struct sdio_al_channel_handle *cnss_sdio_wlan_register_sdio_al_channel(
 281                                     struct sdio_al_channel_data *channel_data);
 282 extern void cnss_sdio_wlan_unregister_sdio_al_channel(
 283              struct sdio_al_channel_handle *ch_handle);
 284 #else
 285 extern inline int cnss_sdio_wlan_register_driver(void *driver_ops)
 286 {
 287         return 0;
 288 }
 289
 290 extern inline void cnss_sdio_wlan_unregister_driver(void *driver_ops)
 291 {
 292
 293 }
 294
 295 extern inline void *cnss_sdio_wlan_get_sdio_al_client_handle(void *func)
 296 {
 297         return NULL;
 298 }
 299
 300 extern inline void *cnss_sdio_wlan_register_sdio_al_channel(void *channel_data)
 301 {
 302         return NULL;
 303 }
 304
 305 extern inline void cnss_sdio_wlan_unregister_sdio_al_channel(void *ch_handle)
 306 {
 307
 308 }
 309 #endif
 310
 311 #endif /* _NET_CNSS2_H */